securityhub

package
v1.51.25 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2024 License: Apache-2.0 Imports: 10 Imported by: 62

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 your security state in Amazon Web Services and helps you assess your Amazon Web Services environment against security industry standards and best practices.

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and supported third-party products and helps you analyze your security trends and identify the highest priority security issues.

To help you manage the security state of your organization, Security Hub supports multiple security standards. These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services, and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes several security controls, each of which represents a security best practice. Security Hub runs checks against security controls and generates control findings to help you assess your compliance against security best practices.

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services, such as Amazon GuardDuty and Amazon Inspector, and supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You can also send Security Hub findings to other Amazon Web Services and supported third-party products.

Security Hub offers automation features that help you triage and remediate security issues. For example, you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with Amazon EventBridge to trigger automatic responses to specific findings.

This guide, the Security Hub API Reference, provides information about the Security Hub API. This includes supported resources, HTTP methods, parameters, and schemas. If you're new to Security Hub, you might find it helpful to also review the Security Hub User Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html). The user guide explains key concepts and provides procedures that demonstrate how to use Security Hub features. It also provides information about topics such as integrating Security Hub with other Amazon Web Services.

In addition to interacting with Security Hub by making calls to the Security Hub API, you can use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to Security Hub and other Amazon Web Services . They also handle tasks such as signing requests, managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools and SDKs, see Tools to Build on Amazon Web Services (http://aws.amazon.com/developer/tools/).

With the exception of operations that are related to central configuration, Security Hub API 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, call the same API operation in each Region in which you want to apply the change. When you use central configuration, API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of central configuration operations, see the Central configuration terms and concepts (https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts) section of the Security Hub User Guide.

The following throttling limits apply to 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 (
	// AssociationTypeInherited is a AssociationType enum value
	AssociationTypeInherited = "INHERITED"

	// AssociationTypeApplied is a AssociationType enum value
	AssociationTypeApplied = "APPLIED"
)
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 (
	// ConfigurationPolicyAssociationStatusPending is a ConfigurationPolicyAssociationStatus enum value
	ConfigurationPolicyAssociationStatusPending = "PENDING"

	// ConfigurationPolicyAssociationStatusSuccess is a ConfigurationPolicyAssociationStatus enum value
	ConfigurationPolicyAssociationStatusSuccess = "SUCCESS"

	// ConfigurationPolicyAssociationStatusFailed is a ConfigurationPolicyAssociationStatus enum value
	ConfigurationPolicyAssociationStatusFailed = "FAILED"
)
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 (
	// OrganizationConfigurationConfigurationTypeCentral is a OrganizationConfigurationConfigurationType enum value
	OrganizationConfigurationConfigurationTypeCentral = "CENTRAL"

	// OrganizationConfigurationConfigurationTypeLocal is a OrganizationConfigurationConfigurationType enum value
	OrganizationConfigurationConfigurationTypeLocal = "LOCAL"
)
View Source 
const (
	// OrganizationConfigurationStatusPending is a OrganizationConfigurationStatus enum value
	OrganizationConfigurationStatusPending = "PENDING"

	// OrganizationConfigurationStatusEnabled is a OrganizationConfigurationStatus enum value
	OrganizationConfigurationStatusEnabled = "ENABLED"

	// OrganizationConfigurationStatusFailed is a OrganizationConfigurationStatus enum value
	OrganizationConfigurationStatusFailed = "FAILED"
)
View Source 
const (
	// ParameterValueTypeDefault is a ParameterValueType enum value
	ParameterValueTypeDefault = "DEFAULT"

	// ParameterValueTypeCustom is a ParameterValueType enum value
	ParameterValueTypeCustom = "CUSTOM"
)
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 (
	// TargetTypeAccount is a TargetType enum value
	TargetTypeAccount = "ACCOUNT"

	// TargetTypeOrganizationalUnit is a TargetType enum value
	TargetTypeOrganizationalUnit = "ORGANIZATIONAL_UNIT"
)
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 (
	// UpdateStatusReady is a UpdateStatus enum value
	UpdateStatusReady = "READY"

	// UpdateStatusUpdating is a UpdateStatus enum value
	UpdateStatusUpdating = "UPDATING"
)
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 (
	// VulnerabilityExploitAvailableYes is a VulnerabilityExploitAvailable enum value
	VulnerabilityExploitAvailableYes = "YES"

	// VulnerabilityExploitAvailableNo is a VulnerabilityExploitAvailable enum value
	VulnerabilityExploitAvailableNo = "NO"
)
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"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The request was rejected because it conflicts with the resource's availability.
	// For example, you tried to update a security control that's currently in the
	// UPDATING state.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// 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"
)
View Source 
const (
	// SecurityControlPropertyParameters is a SecurityControlProperty enum value
	SecurityControlPropertyParameters = "Parameters"
)

Variables

This section is empty.

Functions

func AdminStatus_Values added in v1.35.34 

func AdminStatus_Values() []string

AdminStatus_Values returns all elements of the AdminStatus enum

func AssociationStatus_Values added in v1.44.209 

func AssociationStatus_Values() []string

AssociationStatus_Values returns all elements of the AssociationStatus enum

func AssociationType_Values added in v1.48.5 

func AssociationType_Values() []string

AssociationType_Values returns all elements of the AssociationType enum

func AutoEnableStandards_Values added in v1.44.0 

func AutoEnableStandards_Values() []string

AutoEnableStandards_Values returns all elements of the AutoEnableStandards enum

func AutomationRulesActionType_Values added in v1.44.282 

func AutomationRulesActionType_Values() []string

AutomationRulesActionType_Values returns all elements of the AutomationRulesActionType enum

func AwsIamAccessKeyStatus_Values added in v1.34.3 

func AwsIamAccessKeyStatus_Values() []string

AwsIamAccessKeyStatus_Values returns all elements of the AwsIamAccessKeyStatus enum

func AwsS3BucketNotificationConfigurationS3KeyFilterRuleName_Values added in v1.40.36 

func AwsS3BucketNotificationConfigurationS3KeyFilterRuleName_Values() []string

AwsS3BucketNotificationConfigurationS3KeyFilterRuleName_Values returns all elements of the AwsS3BucketNotificationConfigurationS3KeyFilterRuleName enum

func ComplianceStatus_Values added in v1.34.3 

func ComplianceStatus_Values() []string

ComplianceStatus_Values returns all elements of the ComplianceStatus enum

func ConfigurationPolicyAssociationStatus_Values added in v1.48.5 

func ConfigurationPolicyAssociationStatus_Values() []string

ConfigurationPolicyAssociationStatus_Values returns all elements of the ConfigurationPolicyAssociationStatus enum

func ControlFindingGenerator_Values added in v1.44.209 

func ControlFindingGenerator_Values() []string

ControlFindingGenerator_Values returns all elements of the ControlFindingGenerator enum

func ControlStatus_Values added in v1.34.3 

func ControlStatus_Values() []string

ControlStatus_Values returns all elements of the ControlStatus enum

func DateRangeUnit_Values added in v1.34.3 

func DateRangeUnit_Values() []string

DateRangeUnit_Values returns all elements of the DateRangeUnit enum

func FindingHistoryUpdateSourceType_Values added in v1.44.257 

func FindingHistoryUpdateSourceType_Values() []string

FindingHistoryUpdateSourceType_Values returns all elements of the FindingHistoryUpdateSourceType enum

func IntegrationType_Values added in v1.34.3 

func IntegrationType_Values() []string

IntegrationType_Values returns all elements of the IntegrationType enum

func MalwareState_Values added in v1.34.3 

func MalwareState_Values() []string

MalwareState_Values returns all elements of the MalwareState enum

func MalwareType_Values added in v1.34.3 

func MalwareType_Values() []string

MalwareType_Values returns all elements of the MalwareType enum

func MapFilterComparison_Values added in v1.34.3 

func MapFilterComparison_Values() []string

MapFilterComparison_Values returns all elements of the MapFilterComparison enum

func NetworkDirection_Values added in v1.34.3 

func NetworkDirection_Values() []string

NetworkDirection_Values returns all elements of the NetworkDirection enum

func OrganizationConfigurationConfigurationType_Values added in v1.48.5 

func OrganizationConfigurationConfigurationType_Values() []string

OrganizationConfigurationConfigurationType_Values returns all elements of the OrganizationConfigurationConfigurationType enum

func OrganizationConfigurationStatus_Values added in v1.48.5 

func OrganizationConfigurationStatus_Values() []string

OrganizationConfigurationStatus_Values returns all elements of the OrganizationConfigurationStatus enum

func ParameterValueType_Values added in v1.48.4 

func ParameterValueType_Values() []string

ParameterValueType_Values returns all elements of the ParameterValueType enum

func Partition_Values added in v1.34.3 

func Partition_Values() []string

Partition_Values returns all elements of the Partition enum

func RecordState_Values added in v1.34.3 

func RecordState_Values() []string

RecordState_Values returns all elements of the RecordState enum

func RegionAvailabilityStatus_Values added in v1.44.209 

func RegionAvailabilityStatus_Values() []string

RegionAvailabilityStatus_Values returns all elements of the RegionAvailabilityStatus enum

func RuleStatus_Values added in v1.44.282 

func RuleStatus_Values() []string

RuleStatus_Values returns all elements of the RuleStatus enum

func SecurityControlProperty_Values added in v1.48.4 

func SecurityControlProperty_Values() []string

SecurityControlProperty_Values returns all elements of the SecurityControlProperty enum

func SeverityLabel_Values added in v1.34.3 

func SeverityLabel_Values() []string

SeverityLabel_Values returns all elements of the SeverityLabel enum

func SeverityRating_Values added in v1.34.3 

func SeverityRating_Values() []string

SeverityRating_Values returns all elements of the SeverityRating enum

func SortOrder_Values added in v1.34.3 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func StandardsStatus_Values added in v1.34.3 

func StandardsStatus_Values() []string

StandardsStatus_Values returns all elements of the StandardsStatus enum

func StatusReasonCode_Values added in v1.42.24 

func StatusReasonCode_Values() []string

StatusReasonCode_Values returns all elements of the StatusReasonCode enum

func StringFilterComparison_Values added in v1.34.3 

func StringFilterComparison_Values() []string

StringFilterComparison_Values returns all elements of the StringFilterComparison enum

func TargetType_Values added in v1.48.5 

func TargetType_Values() []string

TargetType_Values returns all elements of the TargetType enum

func ThreatIntelIndicatorCategory_Values added in v1.34.3 

func ThreatIntelIndicatorCategory_Values() []string

ThreatIntelIndicatorCategory_Values returns all elements of the ThreatIntelIndicatorCategory enum

func ThreatIntelIndicatorType_Values added in v1.34.3 

func ThreatIntelIndicatorType_Values() []string

ThreatIntelIndicatorType_Values returns all elements of the ThreatIntelIndicatorType enum

func UnprocessedErrorCode_Values added in v1.44.209 

func UnprocessedErrorCode_Values() []string

UnprocessedErrorCode_Values returns all elements of the UnprocessedErrorCode enum

func UpdateStatus_Values added in v1.48.4 

func UpdateStatus_Values() []string

UpdateStatus_Values returns all elements of the UpdateStatus enum

func VerificationState_Values added in v1.34.3 

func VerificationState_Values() []string

VerificationState_Values returns all elements of the VerificationState enum

func VulnerabilityExploitAvailable_Values added in v1.44.327 

func VulnerabilityExploitAvailable_Values() []string

VulnerabilityExploitAvailable_Values returns all elements of the VulnerabilityExploitAvailable enum

func VulnerabilityFixAvailable_Values added in v1.44.82 

func VulnerabilityFixAvailable_Values() []string

VulnerabilityFixAvailable_Values returns all elements of the VulnerabilityFixAvailable enum

func WorkflowState_Values added in v1.34.3 

func WorkflowState_Values() []string

WorkflowState_Values returns all elements of the WorkflowState enum

func WorkflowStatus_Values added in v1.34.3 

func WorkflowStatus_Values() []string

WorkflowStatus_Values returns all elements of the WorkflowStatus enum

Types

type AcceptAdministratorInvitationInput added in v1.38.24 

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 added in v1.38.24 

func (s AcceptAdministratorInvitationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

func (s *AcceptAdministratorInvitationInput) SetAdministratorId(v string) *AcceptAdministratorInvitationInput

SetAdministratorId sets the AdministratorId field's value.

func (*AcceptAdministratorInvitationInput) SetInvitationId added in v1.38.24 

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

SetInvitationId sets the InvitationId field's value.

func (AcceptAdministratorInvitationInput) String added in v1.38.24 

func (s AcceptAdministratorInvitationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

func (s *AcceptAdministratorInvitationInput) Validate() error

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

type AcceptAdministratorInvitationOutput added in v1.38.24 

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

func (AcceptAdministratorInvitationOutput) GoString added in v1.38.24 

func (s AcceptAdministratorInvitationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

func (s AcceptAdministratorInvitationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

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

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 added in v1.23.9 

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 added in v1.28.0 

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 added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String added in v1.28.0 

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 added in v1.35.34 

func (s *AccountDetails) Validate() error

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

type Action added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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

SetActionType sets the ActionType field's value.

func (*Action) SetAwsApiCallAction added in v1.36.30 

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

SetAwsApiCallAction sets the AwsApiCallAction field's value.

func (*Action) SetDnsRequestAction added in v1.36.30 

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

SetDnsRequestAction sets the DnsRequestAction field's value.

func (*Action) SetNetworkConnectionAction added in v1.36.30 

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

SetNetworkConnectionAction sets the NetworkConnectionAction field's value.

func (*Action) SetPortProbeAction added in v1.36.30 

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

SetPortProbeAction sets the PortProbeAction field's value.

func (Action) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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

SetIpAddressV4 sets the IpAddressV4 field's value.

func (ActionLocalIpDetails) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *ActionLocalPortDetails) SetPort(v int64) *ActionLocalPortDetails

SetPort sets the Port field's value.

func (*ActionLocalPortDetails) SetPortName added in v1.36.30 

func (s *ActionLocalPortDetails) SetPortName(v string) *ActionLocalPortDetails

SetPortName sets the PortName field's value.

func (ActionLocalPortDetails) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *ActionRemoteIpDetails) SetCity(v *City) *ActionRemoteIpDetails

SetCity sets the City field's value.

func (*ActionRemoteIpDetails) SetCountry added in v1.36.30 

func (s *ActionRemoteIpDetails) SetCountry(v *Country) *ActionRemoteIpDetails

SetCountry sets the Country field's value.

func (*ActionRemoteIpDetails) SetGeoLocation added in v1.36.30 

func (s *ActionRemoteIpDetails) SetGeoLocation(v *GeoLocation) *ActionRemoteIpDetails

SetGeoLocation sets the GeoLocation field's value.

func (*ActionRemoteIpDetails) SetIpAddressV4 added in v1.36.30 

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

SetIpAddressV4 sets the IpAddressV4 field's value.

func (*ActionRemoteIpDetails) SetOrganization added in v1.36.30 

func (s *ActionRemoteIpDetails) SetOrganization(v *IpOrganizationDetails) *ActionRemoteIpDetails

SetOrganization sets the Organization field's value.

func (ActionRemoteIpDetails) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *ActionRemotePortDetails) SetPort(v int64) *ActionRemotePortDetails

SetPort sets the Port field's value.

func (*ActionRemotePortDetails) SetPortName added in v1.36.30 

func (s *ActionRemotePortDetails) SetPortName(v string) *ActionRemotePortDetails

SetPortName sets the PortName field's value.

func (ActionRemotePortDetails) String added in v1.36.30 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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

SetActionTargetArn sets the ActionTargetArn field's value.

func (*ActionTarget) SetDescription added in v1.20.7 

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

SetDescription sets the Description field's value.

func (*ActionTarget) SetName added in v1.20.7 

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

SetName sets the Name field's value.

func (ActionTarget) String added in v1.20.7 

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 added in v1.40.36 

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 added in v1.40.36 

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 added in v1.40.36 

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

SetMetric sets the Metric field's value.

func (*Adjustment) SetReason added in v1.40.36 

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

SetReason sets the Reason field's value.

func (Adjustment) String added in v1.40.36 

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 added in v1.35.34 

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 added in v1.35.34 

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 added in v1.35.34 

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

SetAccountId sets the AccountId field's value.

func (*AdminAccount) SetStatus added in v1.35.34 

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

SetStatus sets the Status field's value.

func (AdminAccount) String added in v1.35.34 

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.44.191 

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.44.191 

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.44.191 

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

SetStandardsId sets the StandardsId field's value.

func (AssociatedStandard) String added in v1.44.191 

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 AssociationFilters added in v1.48.5 

type AssociationFilters struct {

	// The current status of the association between a target and a configuration
	// policy.
	AssociationStatus *string `type:"string" enum:"ConfigurationPolicyAssociationStatus"`

	// Indicates whether the association between a target and a configuration was
	// directly applied by the Security Hub delegated administrator or inherited
	// from a parent.
	AssociationType *string `type:"string" enum:"AssociationType"`

	// The ARN or UUID of the configuration policy.
	ConfigurationPolicyId *string `type:"string"`
	// contains filtered or unexported fields
}

Options for filtering the ListConfigurationPolicyAssociations response. You can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a configuration policy, AssociationType, or AssociationStatus.

func (AssociationFilters) GoString added in v1.48.5 

func (s AssociationFilters) GoString() string

GoString returns the string representation.

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

func (*AssociationFilters) SetAssociationStatus added in v1.48.5 

func (s *AssociationFilters) SetAssociationStatus(v string) *AssociationFilters

SetAssociationStatus sets the AssociationStatus field's value.

func (*AssociationFilters) SetAssociationType added in v1.48.5 

func (s *AssociationFilters) SetAssociationType(v string) *AssociationFilters

SetAssociationType sets the AssociationType field's value.

func (*AssociationFilters) SetConfigurationPolicyId added in v1.48.5 

func (s *AssociationFilters) SetConfigurationPolicyId(v string) *AssociationFilters

SetConfigurationPolicyId sets the ConfigurationPolicyId field's value.

func (AssociationFilters) String added in v1.48.5 

func (s AssociationFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

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.44.230 

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.44.230 

func (s *AssociationSetDetails) SetAssociationState(v *AssociationStateDetails) *AssociationSetDetails

SetAssociationState sets the AssociationState field's value.

func (*AssociationSetDetails) SetGatewayId added in v1.44.230 

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

SetGatewayId sets the GatewayId field's value.

func (*AssociationSetDetails) SetMain added in v1.44.230 

func (s *AssociationSetDetails) SetMain(v bool) *AssociationSetDetails

SetMain sets the Main field's value.

func (*AssociationSetDetails) SetRouteTableAssociationId added in v1.44.230 

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

SetRouteTableAssociationId sets the RouteTableAssociationId field's value.

func (*AssociationSetDetails) SetRouteTableId added in v1.44.230 

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

SetRouteTableId sets the RouteTableId field's value.

func (*AssociationSetDetails) SetSubnetId added in v1.44.230 

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

SetSubnetId sets the SubnetId field's value.

func (AssociationSetDetails) String added in v1.44.230 

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.44.230 

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.44.230 

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.44.230 

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

SetState sets the State field's value.

func (*AssociationStateDetails) SetStatusMessage added in v1.44.230 

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

SetStatusMessage sets the StatusMessage field's value.

func (AssociationStateDetails) String added in v1.44.230 

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.44.282 

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.44.282 

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.44.282 

func (s *AutomationRulesAction) SetFindingFieldsUpdate(v *AutomationRulesFindingFieldsUpdate) *AutomationRulesAction

SetFindingFieldsUpdate sets the FindingFieldsUpdate field's value.

func (*AutomationRulesAction) SetType added in v1.44.282 

func (s *AutomationRulesAction) SetType(v string) *AutomationRulesAction

SetType sets the Type field's value.

func (AutomationRulesAction) String added in v1.44.282 

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.44.282 

func (s *AutomationRulesAction) Validate() error

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

type AutomationRulesConfig added in v1.44.282 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.44.282 

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.44.282 

func (s *AutomationRulesConfig) SetActions(v []*AutomationRulesAction) *AutomationRulesConfig

SetActions sets the Actions field's value.

func (*AutomationRulesConfig) SetCreatedAt added in v1.44.282 

func (s *AutomationRulesConfig) SetCreatedAt(v time.Time) *AutomationRulesConfig

SetCreatedAt sets the CreatedAt field's value.

func (*AutomationRulesConfig) SetCreatedBy added in v1.44.282 

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

SetCreatedBy sets the CreatedBy field's value.

func (*AutomationRulesConfig) SetCriteria added in v1.44.282 

func (s *AutomationRulesConfig) SetCriteria(v *AutomationRulesFindingFilters) *AutomationRulesConfig

SetCriteria sets the Criteria field's value.

func (*AutomationRulesConfig) SetDescription added in v1.44.282 

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

SetDescription sets the Description field's value.

func (*AutomationRulesConfig) SetIsTerminal added in v1.44.282 

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

SetIsTerminal sets the IsTerminal field's value.

func (*AutomationRulesConfig) SetRuleArn added in v1.44.282 

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

SetRuleArn sets the RuleArn field's value.

func (*AutomationRulesConfig) SetRuleName added in v1.44.282 

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

SetRuleName sets the RuleName field's value.

func (*AutomationRulesConfig) SetRuleOrder added in v1.44.282 

func (s *AutomationRulesConfig) SetRuleOrder(v int64) *AutomationRulesConfig

SetRuleOrder sets the RuleOrder field's value.

func (*AutomationRulesConfig) SetRuleStatus added in v1.44.282 

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

SetRuleStatus sets the RuleStatus field's value.

func (*AutomationRulesConfig) SetUpdatedAt added in v1.44.282 

func (s *AutomationRulesConfig) SetUpdatedAt(v time.Time) *AutomationRulesConfig

SetUpdatedAt sets the UpdatedAt field's value.

func (AutomationRulesConfig) String added in v1.44.282 

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.44.282 

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.44.282 

func (s AutomationRulesFindingFieldsUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetConfidence(v int64) *AutomationRulesFindingFieldsUpdate

SetConfidence sets the Confidence field's value.

func (*AutomationRulesFindingFieldsUpdate) SetCriticality added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetCriticality(v int64) *AutomationRulesFindingFieldsUpdate

SetCriticality sets the Criticality field's value.

func (*AutomationRulesFindingFieldsUpdate) SetNote added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetNote(v *NoteUpdate) *AutomationRulesFindingFieldsUpdate

SetNote sets the Note field's value.

func (*AutomationRulesFindingFieldsUpdate) SetRelatedFindings added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetRelatedFindings(v []*RelatedFinding) *AutomationRulesFindingFieldsUpdate

SetRelatedFindings sets the RelatedFindings field's value.

func (*AutomationRulesFindingFieldsUpdate) SetSeverity added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetSeverity(v *SeverityUpdate) *AutomationRulesFindingFieldsUpdate

SetSeverity sets the Severity field's value.

func (*AutomationRulesFindingFieldsUpdate) SetTypes added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetTypes(v []*string) *AutomationRulesFindingFieldsUpdate

SetTypes sets the Types field's value.

func (*AutomationRulesFindingFieldsUpdate) SetUserDefinedFields added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetUserDefinedFields(v map[string]*string) *AutomationRulesFindingFieldsUpdate

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*AutomationRulesFindingFieldsUpdate) SetVerificationState added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetVerificationState(v string) *AutomationRulesFindingFieldsUpdate

SetVerificationState sets the VerificationState field's value.

func (*AutomationRulesFindingFieldsUpdate) SetWorkflow added in v1.44.282 

func (s *AutomationRulesFindingFieldsUpdate) SetWorkflow(v *WorkflowUpdate) *AutomationRulesFindingFieldsUpdate

SetWorkflow sets the Workflow field's value.

func (AutomationRulesFindingFieldsUpdate) String added in v1.44.282 

func (s AutomationRulesFindingFieldsUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *AutomationRulesFindingFieldsUpdate) Validate() error

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

type AutomationRulesFindingFilters added in v1.44.282 

type AutomationRulesFindingFilters struct {

	// The Amazon Web Services account ID in which a finding was generated.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 100 items.
	AwsAccountId []*StringFilter `type:"list"`

	// The name of the Amazon Web Services account in which a finding was generated.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	AwsAccountName []*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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ComplianceAssociatedStandardsId []*StringFilter `type:"list"`

	// The security control ID for which a finding was generated. Security control
	// IDs are the same across standards.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ComplianceSecurityControlId []*StringFilter `type:"list"`

	// The result of a security check. This field is only used for findings generated
	// from controls.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	Confidence []*NumberFilter `type:"list"`

	// A timestamp that indicates when this finding record was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	Criticality []*NumberFilter `type:"list"`

	// A finding's description.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	FirstObservedAt []*DateFilter `type:"list"`

	// The identifier for the solution-specific component that generated a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 100 items.
	GeneratorId []*StringFilter `type:"list"`

	// The product-specific identifier for a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	LastObservedAt []*DateFilter `type:"list"`

	// The text of a user-defined note that's added to a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	NoteText []*StringFilter `type:"list"`

	// The timestamp of when the note was updated.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	NoteUpdatedAt []*DateFilter `type:"list"`

	// The principal that created a note.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	NoteUpdatedBy []*StringFilter `type:"list"`

	// The Amazon Resource Name (ARN) for a third-party product that generated a
	// finding in Security Hub.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ProductArn []*StringFilter `type:"list"`

	// Provides the name of the product that generated the finding. For control-based
	// findings, the product name is Security Hub.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ProductName []*StringFilter `type:"list"`

	// Provides the current state of a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	RecordState []*StringFilter `type:"list"`

	// The product-generated identifier for a related finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	RelatedFindingsId []*StringFilter `type:"list"`

	// The ARN for the product that generated a related finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	RelatedFindingsProductArn []*StringFilter `type:"list"`

	// The Amazon Resource Name (ARN) of the application that is related to a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ResourceApplicationArn []*StringFilter `type:"list"`

	// The name of the application that is related to a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ResourceApplicationName []*StringFilter `type:"list"`

	// Custom fields and values about the resource that a finding pertains to.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 100 items.
	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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ResourcePartition []*StringFilter `type:"list"`

	// The Amazon Web Services Region where the resource that a finding pertains
	// to is located.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ResourceRegion []*StringFilter `type:"list"`

	// A list of Amazon Web Services tags associated with a resource at the time
	// the finding was processed.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ResourceTags []*MapFilter `type:"list"`

	// The type of resource that the finding pertains to.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	ResourceType []*StringFilter `type:"list"`

	// The severity value of the finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	SeverityLabel []*StringFilter `type:"list"`

	// Provides a URL that links to a page about the current finding in the finding
	// product.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	SourceUrl []*StringFilter `type:"list"`

	// A finding's title.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 100 items.
	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.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	Type []*StringFilter `type:"list"`

	// A timestamp that indicates when the finding record was most recently updated.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	UpdatedAt []*DateFilter `type:"list"`

	// A list of user-defined name and value string pairs added to a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	UserDefinedFields []*MapFilter `type:"list"`

	// Provides the veracity of a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	VerificationState []*StringFilter `type:"list"`

	// Provides information about the status of the investigation into a finding.
	//
	// Array Members: Minimum number of 1 item. Maximum number of 20 items.
	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.44.282 

func (s AutomationRulesFindingFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

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

SetAwsAccountId sets the AwsAccountId field's value.

func (*AutomationRulesFindingFilters) SetAwsAccountName added in v1.48.5 

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

SetAwsAccountName sets the AwsAccountName field's value.

func (*AutomationRulesFindingFilters) SetCompanyName added in v1.44.282 

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

SetCompanyName sets the CompanyName field's value.

func (*AutomationRulesFindingFilters) SetComplianceAssociatedStandardsId added in v1.44.282 

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

SetComplianceAssociatedStandardsId sets the ComplianceAssociatedStandardsId field's value.

func (*AutomationRulesFindingFilters) SetComplianceSecurityControlId added in v1.44.282 

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

SetComplianceSecurityControlId sets the ComplianceSecurityControlId field's value.

func (*AutomationRulesFindingFilters) SetComplianceStatus added in v1.44.282 

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

SetComplianceStatus sets the ComplianceStatus field's value.

func (*AutomationRulesFindingFilters) SetConfidence added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetConfidence(v []*NumberFilter) *AutomationRulesFindingFilters

SetConfidence sets the Confidence field's value.

func (*AutomationRulesFindingFilters) SetCreatedAt added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetCreatedAt(v []*DateFilter) *AutomationRulesFindingFilters

SetCreatedAt sets the CreatedAt field's value.

func (*AutomationRulesFindingFilters) SetCriticality added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetCriticality(v []*NumberFilter) *AutomationRulesFindingFilters

SetCriticality sets the Criticality field's value.

func (*AutomationRulesFindingFilters) SetDescription added in v1.44.282 

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

SetDescription sets the Description field's value.

func (*AutomationRulesFindingFilters) SetFirstObservedAt added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetFirstObservedAt(v []*DateFilter) *AutomationRulesFindingFilters

SetFirstObservedAt sets the FirstObservedAt field's value.

func (*AutomationRulesFindingFilters) SetGeneratorId added in v1.44.282 

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

SetGeneratorId sets the GeneratorId field's value.

func (*AutomationRulesFindingFilters) SetId added in v1.44.282 

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

SetId sets the Id field's value.

func (*AutomationRulesFindingFilters) SetLastObservedAt added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetLastObservedAt(v []*DateFilter) *AutomationRulesFindingFilters

SetLastObservedAt sets the LastObservedAt field's value.

func (*AutomationRulesFindingFilters) SetNoteText added in v1.44.282 

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

SetNoteText sets the NoteText field's value.

func (*AutomationRulesFindingFilters) SetNoteUpdatedAt added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetNoteUpdatedAt(v []*DateFilter) *AutomationRulesFindingFilters

SetNoteUpdatedAt sets the NoteUpdatedAt field's value.

func (*AutomationRulesFindingFilters) SetNoteUpdatedBy added in v1.44.282 

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

SetNoteUpdatedBy sets the NoteUpdatedBy field's value.

func (*AutomationRulesFindingFilters) SetProductArn added in v1.44.282 

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

SetProductArn sets the ProductArn field's value.

func (*AutomationRulesFindingFilters) SetProductName added in v1.44.282 

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

SetProductName sets the ProductName field's value.

func (*AutomationRulesFindingFilters) SetRecordState added in v1.44.282 

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

SetRecordState sets the RecordState field's value.

func (*AutomationRulesFindingFilters) SetRelatedFindingsId added in v1.44.282 

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

SetRelatedFindingsId sets the RelatedFindingsId field's value.

func (*AutomationRulesFindingFilters) SetRelatedFindingsProductArn added in v1.44.282 

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

SetRelatedFindingsProductArn sets the RelatedFindingsProductArn field's value.

func (*AutomationRulesFindingFilters) SetResourceApplicationArn added in v1.48.5 

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

SetResourceApplicationArn sets the ResourceApplicationArn field's value.

func (*AutomationRulesFindingFilters) SetResourceApplicationName added in v1.48.5 

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

SetResourceApplicationName sets the ResourceApplicationName field's value.

func (*AutomationRulesFindingFilters) SetResourceDetailsOther added in v1.44.282 

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

SetResourceDetailsOther sets the ResourceDetailsOther field's value.

func (*AutomationRulesFindingFilters) SetResourceId added in v1.44.282 

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

SetResourceId sets the ResourceId field's value.

func (*AutomationRulesFindingFilters) SetResourcePartition added in v1.44.282 

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

SetResourcePartition sets the ResourcePartition field's value.

func (*AutomationRulesFindingFilters) SetResourceRegion added in v1.44.282 

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

SetResourceRegion sets the ResourceRegion field's value.

func (*AutomationRulesFindingFilters) SetResourceTags added in v1.44.282 

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

SetResourceTags sets the ResourceTags field's value.

func (*AutomationRulesFindingFilters) SetResourceType added in v1.44.282 

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

SetResourceType sets the ResourceType field's value.

func (*AutomationRulesFindingFilters) SetSeverityLabel added in v1.44.282 

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

SetSeverityLabel sets the SeverityLabel field's value.

func (*AutomationRulesFindingFilters) SetSourceUrl added in v1.44.282 

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

SetSourceUrl sets the SourceUrl field's value.

func (*AutomationRulesFindingFilters) SetTitle added in v1.44.282 

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

SetTitle sets the Title field's value.

func (*AutomationRulesFindingFilters) SetType added in v1.44.282 

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

SetType sets the Type field's value.

func (*AutomationRulesFindingFilters) SetUpdatedAt added in v1.44.282 

func (s *AutomationRulesFindingFilters) SetUpdatedAt(v []*DateFilter) *AutomationRulesFindingFilters

SetUpdatedAt sets the UpdatedAt field's value.

func (*AutomationRulesFindingFilters) SetUserDefinedFields added in v1.44.282 

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

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*AutomationRulesFindingFilters) SetVerificationState added in v1.44.282 

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

SetVerificationState sets the VerificationState field's value.

func (*AutomationRulesFindingFilters) SetWorkflowStatus added in v1.44.282 

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

SetWorkflowStatus sets the WorkflowStatus field's value.

func (AutomationRulesFindingFilters) String added in v1.44.282 

func (s AutomationRulesFindingFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

type AutomationRulesMetadata struct {

	// A timestamp that indicates when the rule was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.44.282 

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.44.282 

func (s *AutomationRulesMetadata) SetCreatedAt(v time.Time) *AutomationRulesMetadata

SetCreatedAt sets the CreatedAt field's value.

func (*AutomationRulesMetadata) SetCreatedBy added in v1.44.282 

func (s *AutomationRulesMetadata) SetCreatedBy(v string) *AutomationRulesMetadata

SetCreatedBy sets the CreatedBy field's value.

func (*AutomationRulesMetadata) SetDescription added in v1.44.282 

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

SetDescription sets the Description field's value.

func (*AutomationRulesMetadata) SetIsTerminal added in v1.44.282 

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

SetIsTerminal sets the IsTerminal field's value.

func (*AutomationRulesMetadata) SetRuleArn added in v1.44.282 

func (s *AutomationRulesMetadata) SetRuleArn(v string) *AutomationRulesMetadata

SetRuleArn sets the RuleArn field's value.

func (*AutomationRulesMetadata) SetRuleName added in v1.44.282 

func (s *AutomationRulesMetadata) SetRuleName(v string) *AutomationRulesMetadata

SetRuleName sets the RuleName field's value.

func (*AutomationRulesMetadata) SetRuleOrder added in v1.44.282 

func (s *AutomationRulesMetadata) SetRuleOrder(v int64) *AutomationRulesMetadata

SetRuleOrder sets the RuleOrder field's value.

func (*AutomationRulesMetadata) SetRuleStatus added in v1.44.282 

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

SetRuleStatus sets the RuleStatus field's value.

func (*AutomationRulesMetadata) SetUpdatedAt added in v1.44.282 

func (s *AutomationRulesMetadata) SetUpdatedAt(v time.Time) *AutomationRulesMetadata

SetUpdatedAt sets the UpdatedAt field's value.

func (AutomationRulesMetadata) String added in v1.44.282 

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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

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

SetSubnetId sets the SubnetId field's value.

func (*AvailabilityZone) SetZoneName added in v1.26.7 

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

SetZoneName sets the ZoneName field's value.

func (AvailabilityZone) String added in v1.26.7 

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.44.272 

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.44.272 

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.44.272 

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

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*AwsAmazonMqBrokerDetails) SetAutoMinorVersionUpgrade added in v1.44.272 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*AwsAmazonMqBrokerDetails) SetBrokerArn added in v1.44.272 

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

SetBrokerArn sets the BrokerArn field's value.

func (*AwsAmazonMqBrokerDetails) SetBrokerId added in v1.44.272 

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

SetBrokerId sets the BrokerId field's value.

func (*AwsAmazonMqBrokerDetails) SetBrokerName added in v1.44.272 

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

SetBrokerName sets the BrokerName field's value.

func (*AwsAmazonMqBrokerDetails) SetDeploymentMode added in v1.44.272 

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

SetDeploymentMode sets the DeploymentMode field's value.

func (*AwsAmazonMqBrokerDetails) SetEncryptionOptions added in v1.44.272 

func (s *AwsAmazonMqBrokerDetails) SetEncryptionOptions(v *AwsAmazonMqBrokerEncryptionOptionsDetails) *AwsAmazonMqBrokerDetails

SetEncryptionOptions sets the EncryptionOptions field's value.

func (*AwsAmazonMqBrokerDetails) SetEngineType added in v1.44.272 

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

SetEngineType sets the EngineType field's value.

func (*AwsAmazonMqBrokerDetails) SetEngineVersion added in v1.44.272 

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

SetEngineVersion sets the EngineVersion field's value.

func (*AwsAmazonMqBrokerDetails) SetHostInstanceType added in v1.44.272 

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

SetHostInstanceType sets the HostInstanceType field's value.

func (*AwsAmazonMqBrokerDetails) SetLdapServerMetadata added in v1.44.272 

func (s *AwsAmazonMqBrokerDetails) SetLdapServerMetadata(v *AwsAmazonMqBrokerLdapServerMetadataDetails) *AwsAmazonMqBrokerDetails

SetLdapServerMetadata sets the LdapServerMetadata field's value.

func (*AwsAmazonMqBrokerDetails) SetLogs added in v1.44.272 

func (s *AwsAmazonMqBrokerDetails) SetLogs(v *AwsAmazonMqBrokerLogsDetails) *AwsAmazonMqBrokerDetails

SetLogs sets the Logs field's value.

func (*AwsAmazonMqBrokerDetails) SetMaintenanceWindowStartTime added in v1.44.272 

func (s *AwsAmazonMqBrokerDetails) SetMaintenanceWindowStartTime(v *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) *AwsAmazonMqBrokerDetails

SetMaintenanceWindowStartTime sets the MaintenanceWindowStartTime field's value.

func (*AwsAmazonMqBrokerDetails) SetPubliclyAccessible added in v1.44.272 

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsAmazonMqBrokerDetails) SetSecurityGroups added in v1.44.272 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsAmazonMqBrokerDetails) SetStorageType added in v1.44.272 

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

SetStorageType sets the StorageType field's value.

func (*AwsAmazonMqBrokerDetails) SetSubnetIds added in v1.44.272 

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

SetSubnetIds sets the SubnetIds field's value.

func (*AwsAmazonMqBrokerDetails) SetUsers added in v1.44.272 

func (s *AwsAmazonMqBrokerDetails) SetUsers(v []*AwsAmazonMqBrokerUsersDetails) *AwsAmazonMqBrokerDetails

SetUsers sets the Users field's value.

func (AwsAmazonMqBrokerDetails) String added in v1.44.272 

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.44.272 

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.44.272 

func (s AwsAmazonMqBrokerEncryptionOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAmazonMqBrokerEncryptionOptionsDetails) SetKmsKeyId(v string) *AwsAmazonMqBrokerEncryptionOptionsDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsAmazonMqBrokerEncryptionOptionsDetails) SetUseAwsOwnedKey added in v1.44.272 

func (s *AwsAmazonMqBrokerEncryptionOptionsDetails) SetUseAwsOwnedKey(v bool) *AwsAmazonMqBrokerEncryptionOptionsDetails

SetUseAwsOwnedKey sets the UseAwsOwnedKey field's value.

func (AwsAmazonMqBrokerEncryptionOptionsDetails) String added in v1.44.272 

func (s AwsAmazonMqBrokerEncryptionOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAmazonMqBrokerLdapServerMetadataDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetHosts(v []*string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetHosts sets the Hosts field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleBase added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleBase(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetRoleBase sets the RoleBase field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleName added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleName(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetRoleName sets the RoleName field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleSearchMatching added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleSearchMatching(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetRoleSearchMatching sets the RoleSearchMatching field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleSearchSubtree added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleSearchSubtree(v bool) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetRoleSearchSubtree sets the RoleSearchSubtree field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetServiceAccountUsername added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetServiceAccountUsername(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetServiceAccountUsername sets the ServiceAccountUsername field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserBase added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserBase(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetUserBase sets the UserBase field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserRoleName added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserRoleName(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetUserRoleName sets the UserRoleName field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserSearchMatching added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserSearchMatching(v string) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetUserSearchMatching sets the UserSearchMatching field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserSearchSubtree added in v1.44.272 

func (s *AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserSearchSubtree(v bool) *AwsAmazonMqBrokerLdapServerMetadataDetails

SetUserSearchSubtree sets the UserSearchSubtree field's value.

func (AwsAmazonMqBrokerLdapServerMetadataDetails) String added in v1.44.272 

func (s AwsAmazonMqBrokerLdapServerMetadataDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

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.44.272 

func (s *AwsAmazonMqBrokerLogsDetails) SetAudit(v bool) *AwsAmazonMqBrokerLogsDetails

SetAudit sets the Audit field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetAuditLogGroup added in v1.44.272 

func (s *AwsAmazonMqBrokerLogsDetails) SetAuditLogGroup(v string) *AwsAmazonMqBrokerLogsDetails

SetAuditLogGroup sets the AuditLogGroup field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetGeneral added in v1.44.272 

func (s *AwsAmazonMqBrokerLogsDetails) SetGeneral(v bool) *AwsAmazonMqBrokerLogsDetails

SetGeneral sets the General field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetGeneralLogGroup added in v1.44.272 

func (s *AwsAmazonMqBrokerLogsDetails) SetGeneralLogGroup(v string) *AwsAmazonMqBrokerLogsDetails

SetGeneralLogGroup sets the GeneralLogGroup field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetPending added in v1.44.272 

func (s *AwsAmazonMqBrokerLogsDetails) SetPending(v *AwsAmazonMqBrokerLogsPendingDetails) *AwsAmazonMqBrokerLogsDetails

SetPending sets the Pending field's value.

func (AwsAmazonMqBrokerLogsDetails) String added in v1.44.272 

func (s AwsAmazonMqBrokerLogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAmazonMqBrokerLogsPendingDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAmazonMqBrokerLogsPendingDetails) SetAudit(v bool) *AwsAmazonMqBrokerLogsPendingDetails

SetAudit sets the Audit field's value.

func (*AwsAmazonMqBrokerLogsPendingDetails) SetGeneral added in v1.44.272 

func (s *AwsAmazonMqBrokerLogsPendingDetails) SetGeneral(v bool) *AwsAmazonMqBrokerLogsPendingDetails

SetGeneral sets the General field's value.

func (AwsAmazonMqBrokerLogsPendingDetails) String added in v1.44.272 

func (s AwsAmazonMqBrokerLogsPendingDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetDayOfWeek(v string) *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails

SetDayOfWeek sets the DayOfWeek field's value.

func (*AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetTimeOfDay added in v1.44.272 

func (s *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetTimeOfDay(v string) *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails

SetTimeOfDay sets the TimeOfDay field's value.

func (*AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetTimeZone added in v1.44.272 

func (s *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetTimeZone(v string) *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails

SetTimeZone sets the TimeZone field's value.

func (AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) String added in v1.44.272 

func (s AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAmazonMqBrokerUsersDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAmazonMqBrokerUsersDetails) SetPendingChange(v string) *AwsAmazonMqBrokerUsersDetails

SetPendingChange sets the PendingChange field's value.

func (*AwsAmazonMqBrokerUsersDetails) SetUsername added in v1.44.272 

func (s *AwsAmazonMqBrokerUsersDetails) SetUsername(v string) *AwsAmazonMqBrokerUsersDetails

SetUsername sets the Username field's value.

func (AwsAmazonMqBrokerUsersDetails) String added in v1.44.272 

func (s AwsAmazonMqBrokerUsersDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

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"`

	// A timestamp that indicates when the API call was first observed.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	FirstSeen *string `type:"string"`

	// A timestamp that indicates when the API call was most recently observed.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.36.30 

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 added in v1.36.30 

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

SetAffectedResources sets the AffectedResources field's value.

func (*AwsApiCallAction) SetApi added in v1.36.30 

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

SetApi sets the Api field's value.

func (*AwsApiCallAction) SetCallerType added in v1.36.30 

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

SetCallerType sets the CallerType field's value.

func (*AwsApiCallAction) SetDomainDetails added in v1.36.30 

func (s *AwsApiCallAction) SetDomainDetails(v *AwsApiCallActionDomainDetails) *AwsApiCallAction

SetDomainDetails sets the DomainDetails field's value.

func (*AwsApiCallAction) SetFirstSeen added in v1.36.30 

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

SetFirstSeen sets the FirstSeen field's value.

func (*AwsApiCallAction) SetLastSeen added in v1.36.30 

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

SetLastSeen sets the LastSeen field's value.

func (*AwsApiCallAction) SetRemoteIpDetails added in v1.36.30 

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

SetRemoteIpDetails sets the RemoteIpDetails field's value.

func (*AwsApiCallAction) SetServiceName added in v1.36.30 

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

SetServiceName sets the ServiceName field's value.

func (AwsApiCallAction) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s AwsApiCallActionDomainDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

func (s *AwsApiCallActionDomainDetails) SetDomain(v string) *AwsApiCallActionDomainDetails

SetDomain sets the Domain field's value.

func (AwsApiCallActionDomainDetails) String added in v1.36.30 

func (s AwsApiCallActionDomainDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsApiGatewayAccessLogSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsApiGatewayAccessLogSettings) SetDestinationArn(v string) *AwsApiGatewayAccessLogSettings

SetDestinationArn sets the DestinationArn field's value.

func (*AwsApiGatewayAccessLogSettings) SetFormat added in v1.35.0 

func (s *AwsApiGatewayAccessLogSettings) SetFormat(v string) *AwsApiGatewayAccessLogSettings

SetFormat sets the Format field's value.

func (AwsApiGatewayAccessLogSettings) String added in v1.35.0 

func (s AwsApiGatewayAccessLogSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsApiGatewayCanarySettings) SetDeploymentId(v string) *AwsApiGatewayCanarySettings

SetDeploymentId sets the DeploymentId field's value.

func (*AwsApiGatewayCanarySettings) SetPercentTraffic added in v1.35.0 

func (s *AwsApiGatewayCanarySettings) SetPercentTraffic(v float64) *AwsApiGatewayCanarySettings

SetPercentTraffic sets the PercentTraffic field's value.

func (*AwsApiGatewayCanarySettings) SetStageVariableOverrides added in v1.35.0 

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

SetStageVariableOverrides sets the StageVariableOverrides field's value.

func (*AwsApiGatewayCanarySettings) SetUseStageCache added in v1.35.0 

func (s *AwsApiGatewayCanarySettings) SetUseStageCache(v bool) *AwsApiGatewayCanarySettings

SetUseStageCache sets the UseStageCache field's value.

func (AwsApiGatewayCanarySettings) String added in v1.35.0 

func (s AwsApiGatewayCanarySettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsApiGatewayEndpointConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsApiGatewayEndpointConfiguration) SetTypes(v []*string) *AwsApiGatewayEndpointConfiguration

SetTypes sets the Types field's value.

func (AwsApiGatewayEndpointConfiguration) String added in v1.35.0 

func (s AwsApiGatewayEndpointConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

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

SetCacheDataEncrypted sets the CacheDataEncrypted field's value.

func (*AwsApiGatewayMethodSettings) SetCacheTtlInSeconds added in v1.35.0 

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

SetCacheTtlInSeconds sets the CacheTtlInSeconds field's value.

func (*AwsApiGatewayMethodSettings) SetCachingEnabled added in v1.35.0 

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

SetCachingEnabled sets the CachingEnabled field's value.

func (*AwsApiGatewayMethodSettings) SetDataTraceEnabled added in v1.35.0 

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

SetDataTraceEnabled sets the DataTraceEnabled field's value.

func (*AwsApiGatewayMethodSettings) SetHttpMethod added in v1.35.0 

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

SetHttpMethod sets the HttpMethod field's value.

func (*AwsApiGatewayMethodSettings) SetLoggingLevel added in v1.35.0 

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

SetLoggingLevel sets the LoggingLevel field's value.

func (*AwsApiGatewayMethodSettings) SetMetricsEnabled added in v1.35.0 

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

SetMetricsEnabled sets the MetricsEnabled field's value.

func (*AwsApiGatewayMethodSettings) SetRequireAuthorizationForCacheControl added in v1.35.0 

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

SetRequireAuthorizationForCacheControl sets the RequireAuthorizationForCacheControl field's value.

func (*AwsApiGatewayMethodSettings) SetResourcePath added in v1.35.0 

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

SetResourcePath sets the ResourcePath field's value.

func (*AwsApiGatewayMethodSettings) SetThrottlingBurstLimit added in v1.35.0 

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

SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.

func (*AwsApiGatewayMethodSettings) SetThrottlingRateLimit added in v1.35.0 

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

SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.

func (*AwsApiGatewayMethodSettings) SetUnauthorizedCacheControlHeaderStrategy added in v1.35.0 

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

SetUnauthorizedCacheControlHeaderStrategy sets the UnauthorizedCacheControlHeaderStrategy field's value.

func (AwsApiGatewayMethodSettings) String added in v1.35.0 

func (s AwsApiGatewayMethodSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsApiGatewayRestApiDetails) SetApiKeySource(v string) *AwsApiGatewayRestApiDetails

SetApiKeySource sets the ApiKeySource field's value.

func (*AwsApiGatewayRestApiDetails) SetBinaryMediaTypes added in v1.35.0 

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

SetBinaryMediaTypes sets the BinaryMediaTypes field's value.

func (*AwsApiGatewayRestApiDetails) SetCreatedDate added in v1.35.0 

func (s *AwsApiGatewayRestApiDetails) SetCreatedDate(v string) *AwsApiGatewayRestApiDetails

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayRestApiDetails) SetDescription added in v1.35.0 

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

SetDescription sets the Description field's value.

func (*AwsApiGatewayRestApiDetails) SetEndpointConfiguration added in v1.35.0 

func (s *AwsApiGatewayRestApiDetails) SetEndpointConfiguration(v *AwsApiGatewayEndpointConfiguration) *AwsApiGatewayRestApiDetails

SetEndpointConfiguration sets the EndpointConfiguration field's value.

func (*AwsApiGatewayRestApiDetails) SetId added in v1.35.0 

func (s *AwsApiGatewayRestApiDetails) SetId(v string) *AwsApiGatewayRestApiDetails

SetId sets the Id field's value.

func (*AwsApiGatewayRestApiDetails) SetMinimumCompressionSize added in v1.35.0 

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

SetMinimumCompressionSize sets the MinimumCompressionSize field's value.

func (*AwsApiGatewayRestApiDetails) SetName added in v1.35.0 

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

SetName sets the Name field's value.

func (*AwsApiGatewayRestApiDetails) SetVersion added in v1.35.0 

func (s *AwsApiGatewayRestApiDetails) SetVersion(v string) *AwsApiGatewayRestApiDetails

SetVersion sets the Version field's value.

func (AwsApiGatewayRestApiDetails) String added in v1.35.0 

func (s AwsApiGatewayRestApiDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsApiGatewayStageDetails) SetAccessLogSettings(v *AwsApiGatewayAccessLogSettings) *AwsApiGatewayStageDetails

SetAccessLogSettings sets the AccessLogSettings field's value.

func (*AwsApiGatewayStageDetails) SetCacheClusterEnabled added in v1.35.0 

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

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

func (*AwsApiGatewayStageDetails) SetCacheClusterSize added in v1.35.0 

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

SetCacheClusterSize sets the CacheClusterSize field's value.

func (*AwsApiGatewayStageDetails) SetCacheClusterStatus added in v1.35.0 

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

SetCacheClusterStatus sets the CacheClusterStatus field's value.

func (*AwsApiGatewayStageDetails) SetCanarySettings added in v1.35.0 

func (s *AwsApiGatewayStageDetails) SetCanarySettings(v *AwsApiGatewayCanarySettings) *AwsApiGatewayStageDetails

SetCanarySettings sets the CanarySettings field's value.

func (*AwsApiGatewayStageDetails) SetClientCertificateId added in v1.35.0 

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

SetClientCertificateId sets the ClientCertificateId field's value.

func (*AwsApiGatewayStageDetails) SetCreatedDate added in v1.35.0 

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

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayStageDetails) SetDeploymentId added in v1.35.0 

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

SetDeploymentId sets the DeploymentId field's value.

func (*AwsApiGatewayStageDetails) SetDescription added in v1.35.0 

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

SetDescription sets the Description field's value.

func (*AwsApiGatewayStageDetails) SetDocumentationVersion added in v1.35.0 

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

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*AwsApiGatewayStageDetails) SetLastUpdatedDate added in v1.35.0 

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

SetLastUpdatedDate sets the LastUpdatedDate field's value.

func (*AwsApiGatewayStageDetails) SetMethodSettings added in v1.35.0 

func (s *AwsApiGatewayStageDetails) SetMethodSettings(v []*AwsApiGatewayMethodSettings) *AwsApiGatewayStageDetails

SetMethodSettings sets the MethodSettings field's value.

func (*AwsApiGatewayStageDetails) SetStageName added in v1.35.0 

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

SetStageName sets the StageName field's value.

func (*AwsApiGatewayStageDetails) SetTracingEnabled added in v1.35.0 

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

SetTracingEnabled sets the TracingEnabled field's value.

func (*AwsApiGatewayStageDetails) SetVariables added in v1.35.0 

func (s *AwsApiGatewayStageDetails) SetVariables(v map[string]*string) *AwsApiGatewayStageDetails

SetVariables sets the Variables field's value.

func (*AwsApiGatewayStageDetails) SetWebAclArn added in v1.35.0 

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

SetWebAclArn sets the WebAclArn field's value.

func (AwsApiGatewayStageDetails) String added in v1.35.0 

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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

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

SetApiEndpoint sets the ApiEndpoint field's value.

func (*AwsApiGatewayV2ApiDetails) SetApiId added in v1.35.0 

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

SetApiId sets the ApiId field's value.

func (*AwsApiGatewayV2ApiDetails) SetApiKeySelectionExpression added in v1.35.0 

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

SetApiKeySelectionExpression sets the ApiKeySelectionExpression field's value.

func (*AwsApiGatewayV2ApiDetails) SetCorsConfiguration added in v1.35.0 

func (s *AwsApiGatewayV2ApiDetails) SetCorsConfiguration(v *AwsCorsConfiguration) *AwsApiGatewayV2ApiDetails

SetCorsConfiguration sets the CorsConfiguration field's value.

func (*AwsApiGatewayV2ApiDetails) SetCreatedDate added in v1.35.0 

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

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayV2ApiDetails) SetDescription added in v1.35.0 

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

SetDescription sets the Description field's value.

func (*AwsApiGatewayV2ApiDetails) SetName added in v1.35.0 

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

SetName sets the Name field's value.

func (*AwsApiGatewayV2ApiDetails) SetProtocolType added in v1.35.0 

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

SetProtocolType sets the ProtocolType field's value.

func (*AwsApiGatewayV2ApiDetails) SetRouteSelectionExpression added in v1.35.0 

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

SetRouteSelectionExpression sets the RouteSelectionExpression field's value.

func (*AwsApiGatewayV2ApiDetails) SetVersion added in v1.35.0 

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

SetVersion sets the Version field's value.

func (AwsApiGatewayV2ApiDetails) String added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

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

SetDataTraceEnabled sets the DataTraceEnabled field's value.

func (*AwsApiGatewayV2RouteSettings) SetDetailedMetricsEnabled added in v1.35.0 

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

SetDetailedMetricsEnabled sets the DetailedMetricsEnabled field's value.

func (*AwsApiGatewayV2RouteSettings) SetLoggingLevel added in v1.35.0 

func (s *AwsApiGatewayV2RouteSettings) SetLoggingLevel(v string) *AwsApiGatewayV2RouteSettings

SetLoggingLevel sets the LoggingLevel field's value.

func (*AwsApiGatewayV2RouteSettings) SetThrottlingBurstLimit added in v1.35.0 

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

SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.

func (*AwsApiGatewayV2RouteSettings) SetThrottlingRateLimit added in v1.35.0 

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

SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.

func (AwsApiGatewayV2RouteSettings) String added in v1.35.0 

func (s AwsApiGatewayV2RouteSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsApiGatewayV2StageDetails) SetAccessLogSettings(v *AwsApiGatewayAccessLogSettings) *AwsApiGatewayV2StageDetails

SetAccessLogSettings sets the AccessLogSettings field's value.

func (*AwsApiGatewayV2StageDetails) SetApiGatewayManaged added in v1.35.0 

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

SetApiGatewayManaged sets the ApiGatewayManaged field's value.

func (*AwsApiGatewayV2StageDetails) SetAutoDeploy added in v1.35.0 

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

SetAutoDeploy sets the AutoDeploy field's value.

func (*AwsApiGatewayV2StageDetails) SetClientCertificateId added in v1.38.67 

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

SetClientCertificateId sets the ClientCertificateId field's value.

func (*AwsApiGatewayV2StageDetails) SetCreatedDate added in v1.35.0 

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

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayV2StageDetails) SetDefaultRouteSettings added in v1.35.0 

func (s *AwsApiGatewayV2StageDetails) SetDefaultRouteSettings(v *AwsApiGatewayV2RouteSettings) *AwsApiGatewayV2StageDetails

SetDefaultRouteSettings sets the DefaultRouteSettings field's value.

func (*AwsApiGatewayV2StageDetails) SetDeploymentId added in v1.35.0 

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

SetDeploymentId sets the DeploymentId field's value.

func (*AwsApiGatewayV2StageDetails) SetDescription added in v1.35.0 

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

SetDescription sets the Description field's value.

func (*AwsApiGatewayV2StageDetails) SetLastDeploymentStatusMessage added in v1.35.0 

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

SetLastDeploymentStatusMessage sets the LastDeploymentStatusMessage field's value.

func (*AwsApiGatewayV2StageDetails) SetLastUpdatedDate added in v1.35.0 

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

SetLastUpdatedDate sets the LastUpdatedDate field's value.

func (*AwsApiGatewayV2StageDetails) SetRouteSettings added in v1.35.0 

func (s *AwsApiGatewayV2StageDetails) SetRouteSettings(v *AwsApiGatewayV2RouteSettings) *AwsApiGatewayV2StageDetails

SetRouteSettings sets the RouteSettings field's value.

func (*AwsApiGatewayV2StageDetails) SetStageName added in v1.35.0 

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

SetStageName sets the StageName field's value.

func (*AwsApiGatewayV2StageDetails) SetStageVariables added in v1.35.0 

func (s *AwsApiGatewayV2StageDetails) SetStageVariables(v map[string]*string) *AwsApiGatewayV2StageDetails

SetStageVariables sets the StageVariables field's value.

func (AwsApiGatewayV2StageDetails) String added in v1.35.0 

func (s AwsApiGatewayV2StageDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetAuthenticationType sets the AuthenticationType field's value.

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetLambdaAuthorizerConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetLambdaAuthorizerConfig(v *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) *AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails

SetLambdaAuthorizerConfig sets the LambdaAuthorizerConfig field's value.

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetOpenIdConnectConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetOpenIdConnectConfig(v *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) *AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails

SetOpenIdConnectConfig sets the OpenIdConnectConfig field's value.

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetUserPoolConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetUserPoolConfig(v *AwsAppSyncGraphQlApiUserPoolConfigDetails) *AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails

SetUserPoolConfig sets the UserPoolConfig field's value.

func (AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) String added in v1.44.272 

func (s AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

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.44.272 

func (s *AwsAppSyncGraphQlApiDetails) SetAdditionalAuthenticationProviders(v []*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) *AwsAppSyncGraphQlApiDetails

SetAdditionalAuthenticationProviders sets the AdditionalAuthenticationProviders field's value.

func (*AwsAppSyncGraphQlApiDetails) SetApiId added in v1.44.272 

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

SetApiId sets the ApiId field's value.

func (*AwsAppSyncGraphQlApiDetails) SetArn added in v1.44.272 

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

SetArn sets the Arn field's value.

func (*AwsAppSyncGraphQlApiDetails) SetAuthenticationType added in v1.44.272 

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

SetAuthenticationType sets the AuthenticationType field's value.

func (*AwsAppSyncGraphQlApiDetails) SetId added in v1.44.272 

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

SetId sets the Id field's value.

func (*AwsAppSyncGraphQlApiDetails) SetLambdaAuthorizerConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiDetails) SetLambdaAuthorizerConfig(v *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) *AwsAppSyncGraphQlApiDetails

SetLambdaAuthorizerConfig sets the LambdaAuthorizerConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetLogConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiDetails) SetLogConfig(v *AwsAppSyncGraphQlApiLogConfigDetails) *AwsAppSyncGraphQlApiDetails

SetLogConfig sets the LogConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetName added in v1.44.272 

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

SetName sets the Name field's value.

func (*AwsAppSyncGraphQlApiDetails) SetOpenIdConnectConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiDetails) SetOpenIdConnectConfig(v *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) *AwsAppSyncGraphQlApiDetails

SetOpenIdConnectConfig sets the OpenIdConnectConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetUserPoolConfig added in v1.44.272 

func (s *AwsAppSyncGraphQlApiDetails) SetUserPoolConfig(v *AwsAppSyncGraphQlApiUserPoolConfigDetails) *AwsAppSyncGraphQlApiDetails

SetUserPoolConfig sets the UserPoolConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetWafWebAclArn added in v1.44.272 

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

SetWafWebAclArn sets the WafWebAclArn field's value.

func (*AwsAppSyncGraphQlApiDetails) SetXrayEnabled added in v1.44.272 

func (s *AwsAppSyncGraphQlApiDetails) SetXrayEnabled(v bool) *AwsAppSyncGraphQlApiDetails

SetXrayEnabled sets the XrayEnabled field's value.

func (AwsAppSyncGraphQlApiDetails) String added in v1.44.272 

func (s AwsAppSyncGraphQlApiDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetAuthorizerResultTtlInSeconds(v int64) *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails

SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.

func (*AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetAuthorizerUri added in v1.44.272 

func (s *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetAuthorizerUri(v string) *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails

SetAuthorizerUri sets the AuthorizerUri field's value.

func (*AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetIdentityValidationExpression added in v1.44.272 

func (s *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetIdentityValidationExpression(v string) *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails

SetIdentityValidationExpression sets the IdentityValidationExpression field's value.

func (AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) String added in v1.44.272 

func (s AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAppSyncGraphQlApiLogConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAppSyncGraphQlApiLogConfigDetails) SetCloudWatchLogsRoleArn(v string) *AwsAppSyncGraphQlApiLogConfigDetails

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*AwsAppSyncGraphQlApiLogConfigDetails) SetExcludeVerboseContent added in v1.44.272 

func (s *AwsAppSyncGraphQlApiLogConfigDetails) SetExcludeVerboseContent(v bool) *AwsAppSyncGraphQlApiLogConfigDetails

SetExcludeVerboseContent sets the ExcludeVerboseContent field's value.

func (*AwsAppSyncGraphQlApiLogConfigDetails) SetFieldLogLevel added in v1.44.272 

func (s *AwsAppSyncGraphQlApiLogConfigDetails) SetFieldLogLevel(v string) *AwsAppSyncGraphQlApiLogConfigDetails

SetFieldLogLevel sets the FieldLogLevel field's value.

func (AwsAppSyncGraphQlApiLogConfigDetails) String added in v1.44.272 

func (s AwsAppSyncGraphQlApiLogConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetAuthTtL(v int64) *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails

SetAuthTtL sets the AuthTtL field's value.

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetClientId added in v1.44.272 

func (s *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetClientId(v string) *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails

SetClientId sets the ClientId field's value.

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetIatTtL added in v1.44.272 

func (s *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetIatTtL(v int64) *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails

SetIatTtL sets the IatTtL field's value.

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetIssuer added in v1.44.272 

func (s *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetIssuer(v string) *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails

SetIssuer sets the Issuer field's value.

func (AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) String added in v1.44.272 

func (s AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsAppSyncGraphQlApiUserPoolConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsAppSyncGraphQlApiUserPoolConfigDetails) SetAppIdClientRegex(v string) *AwsAppSyncGraphQlApiUserPoolConfigDetails

SetAppIdClientRegex sets the AppIdClientRegex field's value.

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetAwsRegion added in v1.44.272 

func (s *AwsAppSyncGraphQlApiUserPoolConfigDetails) SetAwsRegion(v string) *AwsAppSyncGraphQlApiUserPoolConfigDetails

SetAwsRegion sets the AwsRegion field's value.

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetDefaultAction added in v1.44.272 

func (s *AwsAppSyncGraphQlApiUserPoolConfigDetails) SetDefaultAction(v string) *AwsAppSyncGraphQlApiUserPoolConfigDetails

SetDefaultAction sets the DefaultAction field's value.

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetUserPoolId added in v1.44.272 

func (s *AwsAppSyncGraphQlApiUserPoolConfigDetails) SetUserPoolId(v string) *AwsAppSyncGraphQlApiUserPoolConfigDetails

SetUserPoolId sets the UserPoolId field's value.

func (AwsAppSyncGraphQlApiUserPoolConfigDetails) String added in v1.44.272 

func (s AwsAppSyncGraphQlApiUserPoolConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

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.44.308 

func (s AwsAthenaWorkGroupConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

func (s *AwsAthenaWorkGroupConfigurationDetails) SetResultConfiguration(v *AwsAthenaWorkGroupConfigurationResultConfigurationDetails) *AwsAthenaWorkGroupConfigurationDetails

SetResultConfiguration sets the ResultConfiguration field's value.

func (AwsAthenaWorkGroupConfigurationDetails) String added in v1.44.308 

func (s AwsAthenaWorkGroupConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

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.44.308 

func (s AwsAthenaWorkGroupConfigurationResultConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

func (s *AwsAthenaWorkGroupConfigurationResultConfigurationDetails) SetEncryptionConfiguration(v *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) *AwsAthenaWorkGroupConfigurationResultConfigurationDetails

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (AwsAthenaWorkGroupConfigurationResultConfigurationDetails) String added in v1.44.308 

func (s AwsAthenaWorkGroupConfigurationResultConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

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.44.308 

func (s AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

func (s *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) SetEncryptionOption(v string) *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails

SetEncryptionOption sets the EncryptionOption field's value.

func (*AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) SetKmsKey added in v1.44.308 

func (s *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) SetKmsKey(v string) *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails

SetKmsKey sets the KmsKey field's value.

func (AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) String added in v1.44.308 

func (s AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

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.44.308 

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.44.308 

func (s *AwsAthenaWorkGroupDetails) SetConfiguration(v *AwsAthenaWorkGroupConfigurationDetails) *AwsAthenaWorkGroupDetails

SetConfiguration sets the Configuration field's value.

func (*AwsAthenaWorkGroupDetails) SetDescription added in v1.44.308 

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

SetDescription sets the Description field's value.

func (*AwsAthenaWorkGroupDetails) SetName added in v1.44.308 

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

SetName sets the Name field's value.

func (*AwsAthenaWorkGroupDetails) SetState added in v1.44.308 

func (s *AwsAthenaWorkGroupDetails) SetState(v string) *AwsAthenaWorkGroupDetails

SetState sets the State field's value.

func (AwsAthenaWorkGroupDetails) String added in v1.44.308 

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.24 

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.24 

func (s AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) SetValue(v string) *AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails

SetValue sets the Value field's value.

func (AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) String added in v1.42.24 

func (s AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.33.0 

func (s AwsAutoScalingAutoScalingGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetAvailabilityZones(v []*AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) *AwsAutoScalingAutoScalingGroupDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetCapacityRebalance added in v1.43.33 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetCapacityRebalance(v bool) *AwsAutoScalingAutoScalingGroupDetails

SetCapacityRebalance sets the CapacityRebalance field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetCreatedTime added in v1.33.0 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetCreatedTime(v string) *AwsAutoScalingAutoScalingGroupDetails

SetCreatedTime sets the CreatedTime field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetHealthCheckGracePeriod added in v1.33.0 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetHealthCheckGracePeriod(v int64) *AwsAutoScalingAutoScalingGroupDetails

SetHealthCheckGracePeriod sets the HealthCheckGracePeriod field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetHealthCheckType added in v1.33.0 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetHealthCheckType(v string) *AwsAutoScalingAutoScalingGroupDetails

SetHealthCheckType sets the HealthCheckType field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetLaunchConfigurationName added in v1.33.0 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetLaunchConfigurationName(v string) *AwsAutoScalingAutoScalingGroupDetails

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetLaunchTemplate added in v1.43.33 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetLaunchTemplate(v *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) *AwsAutoScalingAutoScalingGroupDetails

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetLoadBalancerNames added in v1.33.0 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetLoadBalancerNames(v []*string) *AwsAutoScalingAutoScalingGroupDetails

SetLoadBalancerNames sets the LoadBalancerNames field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetMixedInstancesPolicy added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupDetails) SetMixedInstancesPolicy(v *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) *AwsAutoScalingAutoScalingGroupDetails

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

func (AwsAutoScalingAutoScalingGroupDetails) String added in v1.33.0 

func (s AwsAutoScalingAutoScalingGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

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.43.33 

func (s AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

func (s *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateId(v string) *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateName added in v1.43.33 

func (s *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateName(v string) *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetVersion added in v1.43.33 

func (s *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetVersion(v string) *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification

SetVersion sets the Version field's value.

func (AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) String added in v1.43.33 

func (s AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) SetInstancesDistribution(v *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails

SetInstancesDistribution sets the InstancesDistribution field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) SetLaunchTemplate added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) SetLaunchTemplate(v *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails

SetLaunchTemplate sets the LaunchTemplate field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) String added in v1.42.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandAllocationStrategy(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails

SetOnDemandAllocationStrategy sets the OnDemandAllocationStrategy field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandBaseCapacity added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandBaseCapacity(v int64) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails

SetOnDemandBaseCapacity sets the OnDemandBaseCapacity field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandPercentageAboveBaseCapacity added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandPercentageAboveBaseCapacity(v int64) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails

SetOnDemandPercentageAboveBaseCapacity sets the OnDemandPercentageAboveBaseCapacity field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotAllocationStrategy added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotAllocationStrategy(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails

SetSpotAllocationStrategy sets the SpotAllocationStrategy field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotInstancePools added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotInstancePools(v int64) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails

SetSpotInstancePools sets the SpotInstancePools field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotMaxPrice added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotMaxPrice(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails

SetSpotMaxPrice sets the SpotMaxPrice field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) String added in v1.42.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) SetLaunchTemplateSpecification(v *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails

SetLaunchTemplateSpecification sets the LaunchTemplateSpecification field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) SetOverrides added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) SetOverrides(v []*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails

SetOverrides sets the Overrides field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) String added in v1.42.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateId(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateName added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateName(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetVersion added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetVersion(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification

SetVersion sets the Version field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) String added in v1.42.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) SetInstanceType(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails

SetInstanceType sets the InstanceType field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) SetWeightedCapacity added in v1.42.24 

func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) SetWeightedCapacity(v string) *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails

SetWeightedCapacity sets the WeightedCapacity field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) String added in v1.42.24 

func (s AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetDeviceName(v string) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails

SetDeviceName sets the DeviceName field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetEbs added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetEbs(v *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails

SetEbs sets the Ebs field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetNoDevice added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetNoDevice(v bool) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails

SetNoDevice sets the NoDevice field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetVirtualName added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetVirtualName(v string) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails

SetVirtualName sets the VirtualName field's value.

func (AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) String added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetDeleteOnTermination(v bool) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetEncrypted added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetEncrypted(v bool) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

SetEncrypted sets the Encrypted field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetIops added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetIops(v int64) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

SetIops sets the Iops field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetSnapshotId added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetSnapshotId(v string) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

SetSnapshotId sets the SnapshotId field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetVolumeSize added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetVolumeSize(v int64) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

SetVolumeSize sets the VolumeSize field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetVolumeType added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetVolumeType(v string) *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

SetVolumeType sets the VolumeType field's value.

func (AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) String added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetAssociatePublicIpAddress(v bool) *AwsAutoScalingLaunchConfigurationDetails

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetBlockDeviceMappings added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetBlockDeviceMappings(v []*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) *AwsAutoScalingLaunchConfigurationDetails

SetBlockDeviceMappings sets the BlockDeviceMappings field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetClassicLinkVpcId added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetClassicLinkVpcId(v string) *AwsAutoScalingLaunchConfigurationDetails

SetClassicLinkVpcId sets the ClassicLinkVpcId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetClassicLinkVpcSecurityGroups added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetClassicLinkVpcSecurityGroups(v []*string) *AwsAutoScalingLaunchConfigurationDetails

SetClassicLinkVpcSecurityGroups sets the ClassicLinkVpcSecurityGroups field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetCreatedTime added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetCreatedTime(v string) *AwsAutoScalingLaunchConfigurationDetails

SetCreatedTime sets the CreatedTime field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetEbsOptimized added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetEbsOptimized(v bool) *AwsAutoScalingLaunchConfigurationDetails

SetEbsOptimized sets the EbsOptimized field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetIamInstanceProfile added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetIamInstanceProfile(v string) *AwsAutoScalingLaunchConfigurationDetails

SetIamInstanceProfile sets the IamInstanceProfile field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetImageId added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetImageId(v string) *AwsAutoScalingLaunchConfigurationDetails

SetImageId sets the ImageId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetInstanceMonitoring added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetInstanceMonitoring(v *AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) *AwsAutoScalingLaunchConfigurationDetails

SetInstanceMonitoring sets the InstanceMonitoring field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetInstanceType added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetInstanceType(v string) *AwsAutoScalingLaunchConfigurationDetails

SetInstanceType sets the InstanceType field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetKernelId added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetKernelId(v string) *AwsAutoScalingLaunchConfigurationDetails

SetKernelId sets the KernelId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetKeyName added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetKeyName(v string) *AwsAutoScalingLaunchConfigurationDetails

SetKeyName sets the KeyName field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetLaunchConfigurationName added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetLaunchConfigurationName(v string) *AwsAutoScalingLaunchConfigurationDetails

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetMetadataOptions added in v1.42.24 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetMetadataOptions(v *AwsAutoScalingLaunchConfigurationMetadataOptions) *AwsAutoScalingLaunchConfigurationDetails

SetMetadataOptions sets the MetadataOptions field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetPlacementTenancy added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetPlacementTenancy(v string) *AwsAutoScalingLaunchConfigurationDetails

SetPlacementTenancy sets the PlacementTenancy field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetRamdiskId added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetRamdiskId(v string) *AwsAutoScalingLaunchConfigurationDetails

SetRamdiskId sets the RamdiskId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetSecurityGroups added in v1.40.36 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetSpotPrice added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetSpotPrice(v string) *AwsAutoScalingLaunchConfigurationDetails

SetSpotPrice sets the SpotPrice field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetUserData added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationDetails) SetUserData(v string) *AwsAutoScalingLaunchConfigurationDetails

SetUserData sets the UserData field's value.

func (AwsAutoScalingLaunchConfigurationDetails) String added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) SetEnabled(v bool) *AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails

SetEnabled sets the Enabled field's value.

func (AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) String added in v1.40.36 

func (s AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsAutoScalingLaunchConfigurationMetadataOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpEndpoint(v string) *AwsAutoScalingLaunchConfigurationMetadataOptions

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpPutResponseHopLimit added in v1.42.24 

func (s *AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpPutResponseHopLimit(v int64) *AwsAutoScalingLaunchConfigurationMetadataOptions

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpTokens added in v1.42.24 

func (s *AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpTokens(v string) *AwsAutoScalingLaunchConfigurationMetadataOptions

SetHttpTokens sets the HttpTokens field's value.

func (AwsAutoScalingLaunchConfigurationMetadataOptions) String added in v1.42.24 

func (s AwsAutoScalingLaunchConfigurationMetadataOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupBackupPlanAdvancedBackupSettingsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetBackupOptions(v map[string]*string) *AwsBackupBackupPlanAdvancedBackupSettingsDetails

SetBackupOptions sets the BackupOptions field's value.

func (*AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetResourceType added in v1.44.82 

func (s *AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetResourceType(v string) *AwsBackupBackupPlanAdvancedBackupSettingsDetails

SetResourceType sets the ResourceType field's value.

func (AwsBackupBackupPlanAdvancedBackupSettingsDetails) String added in v1.44.82 

func (s AwsBackupBackupPlanAdvancedBackupSettingsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupBackupPlanBackupPlanDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupBackupPlanBackupPlanDetails) SetAdvancedBackupSettings(v []*AwsBackupBackupPlanAdvancedBackupSettingsDetails) *AwsBackupBackupPlanBackupPlanDetails

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanName added in v1.44.82 

func (s *AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanName(v string) *AwsBackupBackupPlanBackupPlanDetails

SetBackupPlanName sets the BackupPlanName field's value.

func (*AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanRule added in v1.44.82 

func (s *AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanRule(v []*AwsBackupBackupPlanRuleDetails) *AwsBackupBackupPlanBackupPlanDetails

SetBackupPlanRule sets the BackupPlanRule field's value.

func (AwsBackupBackupPlanBackupPlanDetails) String added in v1.44.82 

func (s AwsBackupBackupPlanBackupPlanDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

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.44.82 

func (s *AwsBackupBackupPlanDetails) SetBackupPlan(v *AwsBackupBackupPlanBackupPlanDetails) *AwsBackupBackupPlanDetails

SetBackupPlan sets the BackupPlan field's value.

func (*AwsBackupBackupPlanDetails) SetBackupPlanArn added in v1.44.82 

func (s *AwsBackupBackupPlanDetails) SetBackupPlanArn(v string) *AwsBackupBackupPlanDetails

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*AwsBackupBackupPlanDetails) SetBackupPlanId added in v1.44.82 

func (s *AwsBackupBackupPlanDetails) SetBackupPlanId(v string) *AwsBackupBackupPlanDetails

SetBackupPlanId sets the BackupPlanId field's value.

func (*AwsBackupBackupPlanDetails) SetVersionId added in v1.44.82 

func (s *AwsBackupBackupPlanDetails) SetVersionId(v string) *AwsBackupBackupPlanDetails

SetVersionId sets the VersionId field's value.

func (AwsBackupBackupPlanDetails) String added in v1.44.82 

func (s AwsBackupBackupPlanDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupBackupPlanLifecycleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupBackupPlanLifecycleDetails) SetDeleteAfterDays(v int64) *AwsBackupBackupPlanLifecycleDetails

SetDeleteAfterDays sets the DeleteAfterDays field's value.

func (*AwsBackupBackupPlanLifecycleDetails) SetMoveToColdStorageAfterDays added in v1.44.82 

func (s *AwsBackupBackupPlanLifecycleDetails) SetMoveToColdStorageAfterDays(v int64) *AwsBackupBackupPlanLifecycleDetails

SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value.

func (AwsBackupBackupPlanLifecycleDetails) String added in v1.44.82 

func (s AwsBackupBackupPlanLifecycleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupBackupPlanRuleCopyActionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupBackupPlanRuleCopyActionsDetails) SetDestinationBackupVaultArn(v string) *AwsBackupBackupPlanRuleCopyActionsDetails

SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.

func (*AwsBackupBackupPlanRuleCopyActionsDetails) SetLifecycle added in v1.44.82 

func (s *AwsBackupBackupPlanRuleCopyActionsDetails) SetLifecycle(v *AwsBackupBackupPlanLifecycleDetails) *AwsBackupBackupPlanRuleCopyActionsDetails

SetLifecycle sets the Lifecycle field's value.

func (AwsBackupBackupPlanRuleCopyActionsDetails) String added in v1.44.82 

func (s AwsBackupBackupPlanRuleCopyActionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupBackupPlanRuleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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

SetCompletionWindowMinutes sets the CompletionWindowMinutes field's value.

func (*AwsBackupBackupPlanRuleDetails) SetCopyActions added in v1.44.82 

func (s *AwsBackupBackupPlanRuleDetails) SetCopyActions(v []*AwsBackupBackupPlanRuleCopyActionsDetails) *AwsBackupBackupPlanRuleDetails

SetCopyActions sets the CopyActions field's value.

func (*AwsBackupBackupPlanRuleDetails) SetEnableContinuousBackup added in v1.44.82 

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

SetEnableContinuousBackup sets the EnableContinuousBackup field's value.

func (*AwsBackupBackupPlanRuleDetails) SetLifecycle added in v1.44.82 

func (s *AwsBackupBackupPlanRuleDetails) SetLifecycle(v *AwsBackupBackupPlanLifecycleDetails) *AwsBackupBackupPlanRuleDetails

SetLifecycle sets the Lifecycle field's value.

func (*AwsBackupBackupPlanRuleDetails) SetRuleId added in v1.44.82 

func (s *AwsBackupBackupPlanRuleDetails) SetRuleId(v string) *AwsBackupBackupPlanRuleDetails

SetRuleId sets the RuleId field's value.

func (*AwsBackupBackupPlanRuleDetails) SetRuleName added in v1.44.82 

func (s *AwsBackupBackupPlanRuleDetails) SetRuleName(v string) *AwsBackupBackupPlanRuleDetails

SetRuleName sets the RuleName field's value.

func (*AwsBackupBackupPlanRuleDetails) SetScheduleExpression added in v1.44.82 

func (s *AwsBackupBackupPlanRuleDetails) SetScheduleExpression(v string) *AwsBackupBackupPlanRuleDetails

SetScheduleExpression sets the ScheduleExpression field's value.

func (*AwsBackupBackupPlanRuleDetails) SetStartWindowMinutes added in v1.44.82 

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

SetStartWindowMinutes sets the StartWindowMinutes field's value.

func (*AwsBackupBackupPlanRuleDetails) SetTargetBackupVault added in v1.44.82 

func (s *AwsBackupBackupPlanRuleDetails) SetTargetBackupVault(v string) *AwsBackupBackupPlanRuleDetails

SetTargetBackupVault sets the TargetBackupVault field's value.

func (AwsBackupBackupPlanRuleDetails) String added in v1.44.82 

func (s AwsBackupBackupPlanRuleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

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.44.82 

func (s *AwsBackupBackupVaultDetails) SetAccessPolicy(v string) *AwsBackupBackupVaultDetails

SetAccessPolicy sets the AccessPolicy field's value.

func (*AwsBackupBackupVaultDetails) SetBackupVaultArn added in v1.44.82 

func (s *AwsBackupBackupVaultDetails) SetBackupVaultArn(v string) *AwsBackupBackupVaultDetails

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*AwsBackupBackupVaultDetails) SetBackupVaultName added in v1.44.82 

func (s *AwsBackupBackupVaultDetails) SetBackupVaultName(v string) *AwsBackupBackupVaultDetails

SetBackupVaultName sets the BackupVaultName field's value.

func (*AwsBackupBackupVaultDetails) SetEncryptionKeyArn added in v1.44.82 

func (s *AwsBackupBackupVaultDetails) SetEncryptionKeyArn(v string) *AwsBackupBackupVaultDetails

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*AwsBackupBackupVaultDetails) SetNotifications added in v1.44.82 

func (s *AwsBackupBackupVaultDetails) SetNotifications(v *AwsBackupBackupVaultNotificationsDetails) *AwsBackupBackupVaultDetails

SetNotifications sets the Notifications field's value.

func (AwsBackupBackupVaultDetails) String added in v1.44.82 

func (s AwsBackupBackupVaultDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupBackupVaultNotificationsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupBackupVaultNotificationsDetails) SetBackupVaultEvents(v []*string) *AwsBackupBackupVaultNotificationsDetails

SetBackupVaultEvents sets the BackupVaultEvents field's value.

func (*AwsBackupBackupVaultNotificationsDetails) SetSnsTopicArn added in v1.44.82 

func (s *AwsBackupBackupVaultNotificationsDetails) SetSnsTopicArn(v string) *AwsBackupBackupVaultNotificationsDetails

SetSnsTopicArn sets the SnsTopicArn field's value.

func (AwsBackupBackupVaultNotificationsDetails) String added in v1.44.82 

func (s AwsBackupBackupVaultNotificationsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupRecoveryPointCalculatedLifecycleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupRecoveryPointCalculatedLifecycleDetails) SetDeleteAt(v string) *AwsBackupRecoveryPointCalculatedLifecycleDetails

SetDeleteAt sets the DeleteAt field's value.

func (*AwsBackupRecoveryPointCalculatedLifecycleDetails) SetMoveToColdStorageAt added in v1.44.82 

func (s *AwsBackupRecoveryPointCalculatedLifecycleDetails) SetMoveToColdStorageAt(v string) *AwsBackupRecoveryPointCalculatedLifecycleDetails

SetMoveToColdStorageAt sets the MoveToColdStorageAt field's value.

func (AwsBackupRecoveryPointCalculatedLifecycleDetails) String added in v1.44.82 

func (s AwsBackupRecoveryPointCalculatedLifecycleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupRecoveryPointCreatedByDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanArn(v string) *AwsBackupRecoveryPointCreatedByDetails

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanId added in v1.44.82 

func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanId(v string) *AwsBackupRecoveryPointCreatedByDetails

SetBackupPlanId sets the BackupPlanId field's value.

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanVersion added in v1.44.82 

func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanVersion(v string) *AwsBackupRecoveryPointCreatedByDetails

SetBackupPlanVersion sets the BackupPlanVersion field's value.

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupRuleId added in v1.44.82 

func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupRuleId(v string) *AwsBackupRecoveryPointCreatedByDetails

SetBackupRuleId sets the BackupRuleId field's value.

func (AwsBackupRecoveryPointCreatedByDetails) String added in v1.44.82 

func (s AwsBackupRecoveryPointCreatedByDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupRecoveryPointDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupRecoveryPointDetails) SetBackupSizeInBytes(v int64) *AwsBackupRecoveryPointDetails

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*AwsBackupRecoveryPointDetails) SetBackupVaultArn added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetBackupVaultArn(v string) *AwsBackupRecoveryPointDetails

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*AwsBackupRecoveryPointDetails) SetBackupVaultName added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetBackupVaultName(v string) *AwsBackupRecoveryPointDetails

SetBackupVaultName sets the BackupVaultName field's value.

func (*AwsBackupRecoveryPointDetails) SetCalculatedLifecycle added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetCalculatedLifecycle(v *AwsBackupRecoveryPointCalculatedLifecycleDetails) *AwsBackupRecoveryPointDetails

SetCalculatedLifecycle sets the CalculatedLifecycle field's value.

func (*AwsBackupRecoveryPointDetails) SetCompletionDate added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetCompletionDate(v string) *AwsBackupRecoveryPointDetails

SetCompletionDate sets the CompletionDate field's value.

func (*AwsBackupRecoveryPointDetails) SetCreatedBy added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetCreatedBy(v *AwsBackupRecoveryPointCreatedByDetails) *AwsBackupRecoveryPointDetails

SetCreatedBy sets the CreatedBy field's value.

func (*AwsBackupRecoveryPointDetails) SetCreationDate added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetCreationDate(v string) *AwsBackupRecoveryPointDetails

SetCreationDate sets the CreationDate field's value.

func (*AwsBackupRecoveryPointDetails) SetEncryptionKeyArn added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetEncryptionKeyArn(v string) *AwsBackupRecoveryPointDetails

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*AwsBackupRecoveryPointDetails) SetIamRoleArn added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetIamRoleArn(v string) *AwsBackupRecoveryPointDetails

SetIamRoleArn sets the IamRoleArn field's value.

func (*AwsBackupRecoveryPointDetails) SetIsEncrypted added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetIsEncrypted(v bool) *AwsBackupRecoveryPointDetails

SetIsEncrypted sets the IsEncrypted field's value.

func (*AwsBackupRecoveryPointDetails) SetLastRestoreTime added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetLastRestoreTime(v string) *AwsBackupRecoveryPointDetails

SetLastRestoreTime sets the LastRestoreTime field's value.

func (*AwsBackupRecoveryPointDetails) SetLifecycle added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetLifecycle(v *AwsBackupRecoveryPointLifecycleDetails) *AwsBackupRecoveryPointDetails

SetLifecycle sets the Lifecycle field's value.

func (*AwsBackupRecoveryPointDetails) SetRecoveryPointArn added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetRecoveryPointArn(v string) *AwsBackupRecoveryPointDetails

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*AwsBackupRecoveryPointDetails) SetResourceArn added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetResourceArn(v string) *AwsBackupRecoveryPointDetails

SetResourceArn sets the ResourceArn field's value.

func (*AwsBackupRecoveryPointDetails) SetResourceType added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetResourceType(v string) *AwsBackupRecoveryPointDetails

SetResourceType sets the ResourceType field's value.

func (*AwsBackupRecoveryPointDetails) SetSourceBackupVaultArn added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetSourceBackupVaultArn(v string) *AwsBackupRecoveryPointDetails

SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.

func (*AwsBackupRecoveryPointDetails) SetStatus added in v1.44.82 

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

SetStatus sets the Status field's value.

func (*AwsBackupRecoveryPointDetails) SetStatusMessage added in v1.44.82 

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

SetStatusMessage sets the StatusMessage field's value.

func (*AwsBackupRecoveryPointDetails) SetStorageClass added in v1.44.82 

func (s *AwsBackupRecoveryPointDetails) SetStorageClass(v string) *AwsBackupRecoveryPointDetails

SetStorageClass sets the StorageClass field's value.

func (AwsBackupRecoveryPointDetails) String added in v1.44.82 

func (s AwsBackupRecoveryPointDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

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.44.82 

func (s AwsBackupRecoveryPointLifecycleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.82 

func (s *AwsBackupRecoveryPointLifecycleDetails) SetDeleteAfterDays(v int64) *AwsBackupRecoveryPointLifecycleDetails

SetDeleteAfterDays sets the DeleteAfterDays field's value.

func (*AwsBackupRecoveryPointLifecycleDetails) SetMoveToColdStorageAfterDays added in v1.44.82 

func (s *AwsBackupRecoveryPointLifecycleDetails) SetMoveToColdStorageAfterDays(v int64) *AwsBackupRecoveryPointLifecycleDetails

SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value.

func (AwsBackupRecoveryPointLifecycleDetails) String added in v1.44.82 

func (s AwsBackupRecoveryPointLifecycleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	NotAfter *string `type:"string"`

	// The time before which the certificate is not valid.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

func (s AwsCertificateManagerCertificateDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetCertificateAuthorityArn(v string) *AwsCertificateManagerCertificateDetails

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*AwsCertificateManagerCertificateDetails) SetCreatedAt added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetCreatedAt(v string) *AwsCertificateManagerCertificateDetails

SetCreatedAt sets the CreatedAt field's value.

func (*AwsCertificateManagerCertificateDetails) SetDomainName added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetDomainName(v string) *AwsCertificateManagerCertificateDetails

SetDomainName sets the DomainName field's value.

func (*AwsCertificateManagerCertificateDetails) SetDomainValidationOptions added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetDomainValidationOptions(v []*AwsCertificateManagerCertificateDomainValidationOption) *AwsCertificateManagerCertificateDetails

SetDomainValidationOptions sets the DomainValidationOptions field's value.

func (*AwsCertificateManagerCertificateDetails) SetExtendedKeyUsages added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetExtendedKeyUsages(v []*AwsCertificateManagerCertificateExtendedKeyUsage) *AwsCertificateManagerCertificateDetails

SetExtendedKeyUsages sets the ExtendedKeyUsages field's value.

func (*AwsCertificateManagerCertificateDetails) SetFailureReason added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetFailureReason(v string) *AwsCertificateManagerCertificateDetails

SetFailureReason sets the FailureReason field's value.

func (*AwsCertificateManagerCertificateDetails) SetImportedAt added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetImportedAt(v string) *AwsCertificateManagerCertificateDetails

SetImportedAt sets the ImportedAt field's value.

func (*AwsCertificateManagerCertificateDetails) SetInUseBy added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetInUseBy(v []*string) *AwsCertificateManagerCertificateDetails

SetInUseBy sets the InUseBy field's value.

func (*AwsCertificateManagerCertificateDetails) SetIssuedAt added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetIssuedAt(v string) *AwsCertificateManagerCertificateDetails

SetIssuedAt sets the IssuedAt field's value.

func (*AwsCertificateManagerCertificateDetails) SetIssuer added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetIssuer(v string) *AwsCertificateManagerCertificateDetails

SetIssuer sets the Issuer field's value.

func (*AwsCertificateManagerCertificateDetails) SetKeyAlgorithm added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetKeyAlgorithm(v string) *AwsCertificateManagerCertificateDetails

SetKeyAlgorithm sets the KeyAlgorithm field's value.

func (*AwsCertificateManagerCertificateDetails) SetKeyUsages added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetKeyUsages(v []*AwsCertificateManagerCertificateKeyUsage) *AwsCertificateManagerCertificateDetails

SetKeyUsages sets the KeyUsages field's value.

func (*AwsCertificateManagerCertificateDetails) SetNotAfter added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetNotAfter(v string) *AwsCertificateManagerCertificateDetails

SetNotAfter sets the NotAfter field's value.

func (*AwsCertificateManagerCertificateDetails) SetNotBefore added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetNotBefore(v string) *AwsCertificateManagerCertificateDetails

SetNotBefore sets the NotBefore field's value.

func (*AwsCertificateManagerCertificateDetails) SetOptions added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetOptions(v *AwsCertificateManagerCertificateOptions) *AwsCertificateManagerCertificateDetails

SetOptions sets the Options field's value.

func (*AwsCertificateManagerCertificateDetails) SetRenewalEligibility added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetRenewalEligibility(v string) *AwsCertificateManagerCertificateDetails

SetRenewalEligibility sets the RenewalEligibility field's value.

func (*AwsCertificateManagerCertificateDetails) SetRenewalSummary added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetRenewalSummary(v *AwsCertificateManagerCertificateRenewalSummary) *AwsCertificateManagerCertificateDetails

SetRenewalSummary sets the RenewalSummary field's value.

func (*AwsCertificateManagerCertificateDetails) SetSerial added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetSerial(v string) *AwsCertificateManagerCertificateDetails

SetSerial sets the Serial field's value.

func (*AwsCertificateManagerCertificateDetails) SetSignatureAlgorithm added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetSignatureAlgorithm(v string) *AwsCertificateManagerCertificateDetails

SetSignatureAlgorithm sets the SignatureAlgorithm field's value.

func (*AwsCertificateManagerCertificateDetails) SetStatus added in v1.35.0 

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

SetStatus sets the Status field's value.

func (*AwsCertificateManagerCertificateDetails) SetSubject added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetSubject(v string) *AwsCertificateManagerCertificateDetails

SetSubject sets the Subject field's value.

func (*AwsCertificateManagerCertificateDetails) SetSubjectAlternativeNames added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetSubjectAlternativeNames(v []*string) *AwsCertificateManagerCertificateDetails

SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value.

func (*AwsCertificateManagerCertificateDetails) SetType added in v1.35.0 

func (s *AwsCertificateManagerCertificateDetails) SetType(v string) *AwsCertificateManagerCertificateDetails

SetType sets the Type field's value.

func (AwsCertificateManagerCertificateDetails) String added in v1.35.0 

func (s AwsCertificateManagerCertificateDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCertificateManagerCertificateDomainValidationOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCertificateManagerCertificateDomainValidationOption) SetDomainName(v string) *AwsCertificateManagerCertificateDomainValidationOption

SetDomainName sets the DomainName field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetResourceRecord added in v1.35.0 

func (s *AwsCertificateManagerCertificateDomainValidationOption) SetResourceRecord(v *AwsCertificateManagerCertificateResourceRecord) *AwsCertificateManagerCertificateDomainValidationOption

SetResourceRecord sets the ResourceRecord field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationDomain added in v1.35.0 

func (s *AwsCertificateManagerCertificateDomainValidationOption) SetValidationDomain(v string) *AwsCertificateManagerCertificateDomainValidationOption

SetValidationDomain sets the ValidationDomain field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationEmails added in v1.35.0 

func (s *AwsCertificateManagerCertificateDomainValidationOption) SetValidationEmails(v []*string) *AwsCertificateManagerCertificateDomainValidationOption

SetValidationEmails sets the ValidationEmails field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationMethod added in v1.35.0 

func (s *AwsCertificateManagerCertificateDomainValidationOption) SetValidationMethod(v string) *AwsCertificateManagerCertificateDomainValidationOption

SetValidationMethod sets the ValidationMethod field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationStatus added in v1.35.0 

func (s *AwsCertificateManagerCertificateDomainValidationOption) SetValidationStatus(v string) *AwsCertificateManagerCertificateDomainValidationOption

SetValidationStatus sets the ValidationStatus field's value.

func (AwsCertificateManagerCertificateDomainValidationOption) String added in v1.35.0 

func (s AwsCertificateManagerCertificateDomainValidationOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCertificateManagerCertificateExtendedKeyUsage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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

SetName sets the Name field's value.

func (*AwsCertificateManagerCertificateExtendedKeyUsage) SetOId added in v1.35.0 

func (s *AwsCertificateManagerCertificateExtendedKeyUsage) SetOId(v string) *AwsCertificateManagerCertificateExtendedKeyUsage

SetOId sets the OId field's value.

func (AwsCertificateManagerCertificateExtendedKeyUsage) String added in v1.35.0 

func (s AwsCertificateManagerCertificateExtendedKeyUsage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCertificateManagerCertificateKeyUsage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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

SetName sets the Name field's value.

func (AwsCertificateManagerCertificateKeyUsage) String added in v1.35.0 

func (s AwsCertificateManagerCertificateKeyUsage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCertificateManagerCertificateOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCertificateManagerCertificateOptions) SetCertificateTransparencyLoggingPreference(v string) *AwsCertificateManagerCertificateOptions

SetCertificateTransparencyLoggingPreference sets the CertificateTransparencyLoggingPreference field's value.

func (AwsCertificateManagerCertificateOptions) String added in v1.35.0 

func (s AwsCertificateManagerCertificateOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

func (s AwsCertificateManagerCertificateRenewalSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCertificateManagerCertificateRenewalSummary) SetDomainValidationOptions(v []*AwsCertificateManagerCertificateDomainValidationOption) *AwsCertificateManagerCertificateRenewalSummary

SetDomainValidationOptions sets the DomainValidationOptions field's value.

func (*AwsCertificateManagerCertificateRenewalSummary) SetRenewalStatus added in v1.35.0 

func (s *AwsCertificateManagerCertificateRenewalSummary) SetRenewalStatus(v string) *AwsCertificateManagerCertificateRenewalSummary

SetRenewalStatus sets the RenewalStatus field's value.

func (*AwsCertificateManagerCertificateRenewalSummary) SetRenewalStatusReason added in v1.35.0 

func (s *AwsCertificateManagerCertificateRenewalSummary) SetRenewalStatusReason(v string) *AwsCertificateManagerCertificateRenewalSummary

SetRenewalStatusReason sets the RenewalStatusReason field's value.

func (*AwsCertificateManagerCertificateRenewalSummary) SetUpdatedAt added in v1.35.0 

func (s *AwsCertificateManagerCertificateRenewalSummary) SetUpdatedAt(v string) *AwsCertificateManagerCertificateRenewalSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (AwsCertificateManagerCertificateRenewalSummary) String added in v1.35.0 

func (s AwsCertificateManagerCertificateRenewalSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCertificateManagerCertificateResourceRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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

SetName sets the Name field's value.

func (*AwsCertificateManagerCertificateResourceRecord) SetType added in v1.35.0 

func (s *AwsCertificateManagerCertificateResourceRecord) SetType(v string) *AwsCertificateManagerCertificateResourceRecord

SetType sets the Type field's value.

func (*AwsCertificateManagerCertificateResourceRecord) SetValue added in v1.35.0 

func (s *AwsCertificateManagerCertificateResourceRecord) SetValue(v string) *AwsCertificateManagerCertificateResourceRecord

SetValue sets the Value field's value.

func (AwsCertificateManagerCertificateResourceRecord) String added in v1.35.0 

func (s AwsCertificateManagerCertificateResourceRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsCloudFormationStackDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsCloudFormationStackDetails) SetCapabilities(v []*string) *AwsCloudFormationStackDetails

SetCapabilities sets the Capabilities field's value.

func (*AwsCloudFormationStackDetails) SetCreationTime added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetCreationTime(v string) *AwsCloudFormationStackDetails

SetCreationTime sets the CreationTime field's value.

func (*AwsCloudFormationStackDetails) SetDescription added in v1.44.36 

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

SetDescription sets the Description field's value.

func (*AwsCloudFormationStackDetails) SetDisableRollback added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetDisableRollback(v bool) *AwsCloudFormationStackDetails

SetDisableRollback sets the DisableRollback field's value.

func (*AwsCloudFormationStackDetails) SetDriftInformation added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetDriftInformation(v *AwsCloudFormationStackDriftInformationDetails) *AwsCloudFormationStackDetails

SetDriftInformation sets the DriftInformation field's value.

func (*AwsCloudFormationStackDetails) SetEnableTerminationProtection added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetEnableTerminationProtection(v bool) *AwsCloudFormationStackDetails

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

func (*AwsCloudFormationStackDetails) SetLastUpdatedTime added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetLastUpdatedTime(v string) *AwsCloudFormationStackDetails

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*AwsCloudFormationStackDetails) SetNotificationArns added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetNotificationArns(v []*string) *AwsCloudFormationStackDetails

SetNotificationArns sets the NotificationArns field's value.

func (*AwsCloudFormationStackDetails) SetOutputs added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetOutputs(v []*AwsCloudFormationStackOutputsDetails) *AwsCloudFormationStackDetails

SetOutputs sets the Outputs field's value.

func (*AwsCloudFormationStackDetails) SetRoleArn added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetRoleArn(v string) *AwsCloudFormationStackDetails

SetRoleArn sets the RoleArn field's value.

func (*AwsCloudFormationStackDetails) SetStackId added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetStackId(v string) *AwsCloudFormationStackDetails

SetStackId sets the StackId field's value.

func (*AwsCloudFormationStackDetails) SetStackName added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetStackName(v string) *AwsCloudFormationStackDetails

SetStackName sets the StackName field's value.

func (*AwsCloudFormationStackDetails) SetStackStatus added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetStackStatus(v string) *AwsCloudFormationStackDetails

SetStackStatus sets the StackStatus field's value.

func (*AwsCloudFormationStackDetails) SetStackStatusReason added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetStackStatusReason(v string) *AwsCloudFormationStackDetails

SetStackStatusReason sets the StackStatusReason field's value.

func (*AwsCloudFormationStackDetails) SetTimeoutInMinutes added in v1.44.36 

func (s *AwsCloudFormationStackDetails) SetTimeoutInMinutes(v int64) *AwsCloudFormationStackDetails

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

func (AwsCloudFormationStackDetails) String added in v1.44.36 

func (s AwsCloudFormationStackDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsCloudFormationStackDriftInformationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsCloudFormationStackDriftInformationDetails) SetStackDriftStatus(v string) *AwsCloudFormationStackDriftInformationDetails

SetStackDriftStatus sets the StackDriftStatus field's value.

func (AwsCloudFormationStackDriftInformationDetails) String added in v1.44.36 

func (s AwsCloudFormationStackDriftInformationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsCloudFormationStackOutputsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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

SetDescription sets the Description field's value.

func (*AwsCloudFormationStackOutputsDetails) SetOutputKey added in v1.44.36 

func (s *AwsCloudFormationStackOutputsDetails) SetOutputKey(v string) *AwsCloudFormationStackOutputsDetails

SetOutputKey sets the OutputKey field's value.

func (*AwsCloudFormationStackOutputsDetails) SetOutputValue added in v1.44.36 

func (s *AwsCloudFormationStackOutputsDetails) SetOutputValue(v string) *AwsCloudFormationStackOutputsDetails

SetOutputValue sets the OutputValue field's value.

func (AwsCloudFormationStackOutputsDetails) String added in v1.44.36 

func (s AwsCloudFormationStackOutputsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionCacheBehavior) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionCacheBehavior) SetViewerProtocolPolicy(v string) *AwsCloudFrontDistributionCacheBehavior

SetViewerProtocolPolicy sets the ViewerProtocolPolicy field's value.

func (AwsCloudFrontDistributionCacheBehavior) String added in v1.35.0 

func (s AwsCloudFrontDistributionCacheBehavior) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionCacheBehaviors) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionCacheBehaviors) SetItems(v []*AwsCloudFrontDistributionCacheBehavior) *AwsCloudFrontDistributionCacheBehaviors

SetItems sets the Items field's value.

func (AwsCloudFrontDistributionCacheBehaviors) String added in v1.35.0 

func (s AwsCloudFrontDistributionCacheBehaviors) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionDefaultCacheBehavior) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionDefaultCacheBehavior) SetViewerProtocolPolicy(v string) *AwsCloudFrontDistributionDefaultCacheBehavior

SetViewerProtocolPolicy sets the ViewerProtocolPolicy field's value.

func (AwsCloudFrontDistributionDefaultCacheBehavior) String added in v1.35.0 

func (s AwsCloudFrontDistributionDefaultCacheBehavior) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.26.7 

func (s AwsCloudFrontDistributionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionDetails) SetCacheBehaviors(v *AwsCloudFrontDistributionCacheBehaviors) *AwsCloudFrontDistributionDetails

SetCacheBehaviors sets the CacheBehaviors field's value.

func (*AwsCloudFrontDistributionDetails) SetDefaultCacheBehavior added in v1.35.0 

func (s *AwsCloudFrontDistributionDetails) SetDefaultCacheBehavior(v *AwsCloudFrontDistributionDefaultCacheBehavior) *AwsCloudFrontDistributionDetails

SetDefaultCacheBehavior sets the DefaultCacheBehavior field's value.

func (*AwsCloudFrontDistributionDetails) SetDefaultRootObject added in v1.35.0 

func (s *AwsCloudFrontDistributionDetails) SetDefaultRootObject(v string) *AwsCloudFrontDistributionDetails

SetDefaultRootObject sets the DefaultRootObject field's value.

func (*AwsCloudFrontDistributionDetails) SetDomainName added in v1.26.7 

func (s *AwsCloudFrontDistributionDetails) SetDomainName(v string) *AwsCloudFrontDistributionDetails

SetDomainName sets the DomainName field's value.

func (*AwsCloudFrontDistributionDetails) SetETag added in v1.26.7 

func (s *AwsCloudFrontDistributionDetails) SetETag(v string) *AwsCloudFrontDistributionDetails

SetETag sets the ETag field's value.

func (*AwsCloudFrontDistributionDetails) SetLastModifiedTime added in v1.26.7 

func (s *AwsCloudFrontDistributionDetails) SetLastModifiedTime(v string) *AwsCloudFrontDistributionDetails

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*AwsCloudFrontDistributionDetails) SetLogging added in v1.26.7 

func (s *AwsCloudFrontDistributionDetails) SetLogging(v *AwsCloudFrontDistributionLogging) *AwsCloudFrontDistributionDetails

SetLogging sets the Logging field's value.

func (*AwsCloudFrontDistributionDetails) SetOriginGroups added in v1.35.0 

func (s *AwsCloudFrontDistributionDetails) SetOriginGroups(v *AwsCloudFrontDistributionOriginGroups) *AwsCloudFrontDistributionDetails

SetOriginGroups sets the OriginGroups field's value.

func (*AwsCloudFrontDistributionDetails) SetOrigins added in v1.26.7 

func (s *AwsCloudFrontDistributionDetails) SetOrigins(v *AwsCloudFrontDistributionOrigins) *AwsCloudFrontDistributionDetails

SetOrigins sets the Origins field's value.

func (*AwsCloudFrontDistributionDetails) SetStatus added in v1.26.7 

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

SetStatus sets the Status field's value.

func (*AwsCloudFrontDistributionDetails) SetViewerCertificate added in v1.40.59 

func (s *AwsCloudFrontDistributionDetails) SetViewerCertificate(v *AwsCloudFrontDistributionViewerCertificate) *AwsCloudFrontDistributionDetails

SetViewerCertificate sets the ViewerCertificate field's value.

func (*AwsCloudFrontDistributionDetails) SetWebAclId added in v1.26.7 

func (s *AwsCloudFrontDistributionDetails) SetWebAclId(v string) *AwsCloudFrontDistributionDetails

SetWebAclId sets the WebAclId field's value.

func (AwsCloudFrontDistributionDetails) String added in v1.26.7 

func (s AwsCloudFrontDistributionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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 added in v1.26.7 

func (s AwsCloudFrontDistributionLogging) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

func (s *AwsCloudFrontDistributionLogging) SetBucket(v string) *AwsCloudFrontDistributionLogging

SetBucket sets the Bucket field's value.

func (*AwsCloudFrontDistributionLogging) SetEnabled added in v1.26.7 

func (s *AwsCloudFrontDistributionLogging) SetEnabled(v bool) *AwsCloudFrontDistributionLogging

SetEnabled sets the Enabled field's value.

func (*AwsCloudFrontDistributionLogging) SetIncludeCookies added in v1.26.7 

func (s *AwsCloudFrontDistributionLogging) SetIncludeCookies(v bool) *AwsCloudFrontDistributionLogging

SetIncludeCookies sets the IncludeCookies field's value.

func (*AwsCloudFrontDistributionLogging) SetPrefix added in v1.26.7 

func (s *AwsCloudFrontDistributionLogging) SetPrefix(v string) *AwsCloudFrontDistributionLogging

SetPrefix sets the Prefix field's value.

func (AwsCloudFrontDistributionLogging) String added in v1.26.7 

func (s AwsCloudFrontDistributionLogging) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsCloudFrontDistributionOriginCustomOriginConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsCloudFrontDistributionOriginCustomOriginConfig) SetHttpPort(v int64) *AwsCloudFrontDistributionOriginCustomOriginConfig

SetHttpPort sets the HttpPort field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetHttpsPort added in v1.44.36 

func (s *AwsCloudFrontDistributionOriginCustomOriginConfig) SetHttpsPort(v int64) *AwsCloudFrontDistributionOriginCustomOriginConfig

SetHttpsPort sets the HttpsPort field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginKeepaliveTimeout added in v1.44.36 

func (s *AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginKeepaliveTimeout(v int64) *AwsCloudFrontDistributionOriginCustomOriginConfig

SetOriginKeepaliveTimeout sets the OriginKeepaliveTimeout field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginProtocolPolicy added in v1.44.36 

func (s *AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginProtocolPolicy(v string) *AwsCloudFrontDistributionOriginCustomOriginConfig

SetOriginProtocolPolicy sets the OriginProtocolPolicy field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginReadTimeout added in v1.44.36 

func (s *AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginReadTimeout(v int64) *AwsCloudFrontDistributionOriginCustomOriginConfig

SetOriginReadTimeout sets the OriginReadTimeout field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginSslProtocols added in v1.44.36 

func (s *AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginSslProtocols(v *AwsCloudFrontDistributionOriginSslProtocols) *AwsCloudFrontDistributionOriginCustomOriginConfig

SetOriginSslProtocols sets the OriginSslProtocols field's value.

func (AwsCloudFrontDistributionOriginCustomOriginConfig) String added in v1.44.36 

func (s AwsCloudFrontDistributionOriginCustomOriginConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginGroup) SetFailoverCriteria(v *AwsCloudFrontDistributionOriginGroupFailover) *AwsCloudFrontDistributionOriginGroup

SetFailoverCriteria sets the FailoverCriteria field's value.

func (AwsCloudFrontDistributionOriginGroup) String added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroupFailover) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginGroupFailover) SetStatusCodes(v *AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) *AwsCloudFrontDistributionOriginGroupFailover

SetStatusCodes sets the StatusCodes field's value.

func (AwsCloudFrontDistributionOriginGroupFailover) String added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroupFailover) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) SetItems(v []*int64) *AwsCloudFrontDistributionOriginGroupFailoverStatusCodes

SetItems sets the Items field's value.

func (*AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) SetQuantity added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) SetQuantity(v int64) *AwsCloudFrontDistributionOriginGroupFailoverStatusCodes

SetQuantity sets the Quantity field's value.

func (AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) String added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroups) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginGroups) SetItems(v []*AwsCloudFrontDistributionOriginGroup) *AwsCloudFrontDistributionOriginGroups

SetItems sets the Items field's value.

func (AwsCloudFrontDistributionOriginGroups) String added in v1.35.0 

func (s AwsCloudFrontDistributionOriginGroups) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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), Elemental MediaStore, or other server from which CloudFront gets your files.

func (AwsCloudFrontDistributionOriginItem) GoString added in v1.26.7 

func (s AwsCloudFrontDistributionOriginItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsCloudFrontDistributionOriginItem) SetCustomOriginConfig(v *AwsCloudFrontDistributionOriginCustomOriginConfig) *AwsCloudFrontDistributionOriginItem

SetCustomOriginConfig sets the CustomOriginConfig field's value.

func (*AwsCloudFrontDistributionOriginItem) SetDomainName added in v1.26.7 

func (s *AwsCloudFrontDistributionOriginItem) SetDomainName(v string) *AwsCloudFrontDistributionOriginItem

SetDomainName sets the DomainName field's value.

func (*AwsCloudFrontDistributionOriginItem) SetId added in v1.26.7 

func (s *AwsCloudFrontDistributionOriginItem) SetId(v string) *AwsCloudFrontDistributionOriginItem

SetId sets the Id field's value.

func (*AwsCloudFrontDistributionOriginItem) SetOriginPath added in v1.26.7 

func (s *AwsCloudFrontDistributionOriginItem) SetOriginPath(v string) *AwsCloudFrontDistributionOriginItem

SetOriginPath sets the OriginPath field's value.

func (*AwsCloudFrontDistributionOriginItem) SetS3OriginConfig added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginItem) SetS3OriginConfig(v *AwsCloudFrontDistributionOriginS3OriginConfig) *AwsCloudFrontDistributionOriginItem

SetS3OriginConfig sets the S3OriginConfig field's value.

func (AwsCloudFrontDistributionOriginItem) String added in v1.26.7 

func (s AwsCloudFrontDistributionOriginItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsCloudFrontDistributionOriginS3OriginConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsCloudFrontDistributionOriginS3OriginConfig) SetOriginAccessIdentity(v string) *AwsCloudFrontDistributionOriginS3OriginConfig

SetOriginAccessIdentity sets the OriginAccessIdentity field's value.

func (AwsCloudFrontDistributionOriginS3OriginConfig) String added in v1.35.0 

func (s AwsCloudFrontDistributionOriginS3OriginConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsCloudFrontDistributionOriginSslProtocols) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsCloudFrontDistributionOriginSslProtocols) SetItems(v []*string) *AwsCloudFrontDistributionOriginSslProtocols

SetItems sets the Items field's value.

func (*AwsCloudFrontDistributionOriginSslProtocols) SetQuantity added in v1.44.36 

func (s *AwsCloudFrontDistributionOriginSslProtocols) SetQuantity(v int64) *AwsCloudFrontDistributionOriginSslProtocols

SetQuantity sets the Quantity field's value.

func (AwsCloudFrontDistributionOriginSslProtocols) String added in v1.44.36 

func (s AwsCloudFrontDistributionOriginSslProtocols) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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 added in v1.26.7 

func (s AwsCloudFrontDistributionOrigins) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

func (s *AwsCloudFrontDistributionOrigins) SetItems(v []*AwsCloudFrontDistributionOriginItem) *AwsCloudFrontDistributionOrigins

SetItems sets the Items field's value.

func (AwsCloudFrontDistributionOrigins) String added in v1.26.7 

func (s AwsCloudFrontDistributionOrigins) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsCloudFrontDistributionViewerCertificate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetAcmCertificateArn(v string) *AwsCloudFrontDistributionViewerCertificate

SetAcmCertificateArn sets the AcmCertificateArn field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetCertificate added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetCertificate(v string) *AwsCloudFrontDistributionViewerCertificate

SetCertificate sets the Certificate field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetCertificateSource added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetCertificateSource(v string) *AwsCloudFrontDistributionViewerCertificate

SetCertificateSource sets the CertificateSource field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetCloudFrontDefaultCertificate added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetCloudFrontDefaultCertificate(v bool) *AwsCloudFrontDistributionViewerCertificate

SetCloudFrontDefaultCertificate sets the CloudFrontDefaultCertificate field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetIamCertificateId added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetIamCertificateId(v string) *AwsCloudFrontDistributionViewerCertificate

SetIamCertificateId sets the IamCertificateId field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetMinimumProtocolVersion added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetMinimumProtocolVersion(v string) *AwsCloudFrontDistributionViewerCertificate

SetMinimumProtocolVersion sets the MinimumProtocolVersion field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetSslSupportMethod added in v1.40.59 

func (s *AwsCloudFrontDistributionViewerCertificate) SetSslSupportMethod(v string) *AwsCloudFrontDistributionViewerCertificate

SetSslSupportMethod sets the SslSupportMethod field's value.

func (AwsCloudFrontDistributionViewerCertificate) String added in v1.40.59 

func (s AwsCloudFrontDistributionViewerCertificate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetCloudWatchLogsLogGroupArn(v string) *AwsCloudTrailTrailDetails

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*AwsCloudTrailTrailDetails) SetCloudWatchLogsRoleArn added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetCloudWatchLogsRoleArn(v string) *AwsCloudTrailTrailDetails

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*AwsCloudTrailTrailDetails) SetHasCustomEventSelectors added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetHasCustomEventSelectors(v bool) *AwsCloudTrailTrailDetails

SetHasCustomEventSelectors sets the HasCustomEventSelectors field's value.

func (*AwsCloudTrailTrailDetails) SetHomeRegion added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetHomeRegion(v string) *AwsCloudTrailTrailDetails

SetHomeRegion sets the HomeRegion field's value.

func (*AwsCloudTrailTrailDetails) SetIncludeGlobalServiceEvents added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetIncludeGlobalServiceEvents(v bool) *AwsCloudTrailTrailDetails

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*AwsCloudTrailTrailDetails) SetIsMultiRegionTrail added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetIsMultiRegionTrail(v bool) *AwsCloudTrailTrailDetails

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*AwsCloudTrailTrailDetails) SetIsOrganizationTrail added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetIsOrganizationTrail(v bool) *AwsCloudTrailTrailDetails

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*AwsCloudTrailTrailDetails) SetKmsKeyId added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetKmsKeyId(v string) *AwsCloudTrailTrailDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsCloudTrailTrailDetails) SetLogFileValidationEnabled added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetLogFileValidationEnabled(v bool) *AwsCloudTrailTrailDetails

SetLogFileValidationEnabled sets the LogFileValidationEnabled field's value.

func (*AwsCloudTrailTrailDetails) SetName added in v1.35.0 

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

SetName sets the Name field's value.

func (*AwsCloudTrailTrailDetails) SetS3BucketName added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetS3BucketName(v string) *AwsCloudTrailTrailDetails

SetS3BucketName sets the S3BucketName field's value.

func (*AwsCloudTrailTrailDetails) SetS3KeyPrefix added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetS3KeyPrefix(v string) *AwsCloudTrailTrailDetails

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*AwsCloudTrailTrailDetails) SetSnsTopicArn added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetSnsTopicArn(v string) *AwsCloudTrailTrailDetails

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*AwsCloudTrailTrailDetails) SetSnsTopicName added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetSnsTopicName(v string) *AwsCloudTrailTrailDetails

SetSnsTopicName sets the SnsTopicName field's value.

func (*AwsCloudTrailTrailDetails) SetTrailArn added in v1.35.0 

func (s *AwsCloudTrailTrailDetails) SetTrailArn(v string) *AwsCloudTrailTrailDetails

SetTrailArn sets the TrailArn field's value.

func (AwsCloudTrailTrailDetails) String added in v1.35.0 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsCloudWatchAlarmDetails) SetActionsEnabled(v bool) *AwsCloudWatchAlarmDetails

SetActionsEnabled sets the ActionsEnabled field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmActions added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetAlarmActions(v []*string) *AwsCloudWatchAlarmDetails

SetAlarmActions sets the AlarmActions field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmArn added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetAlarmArn(v string) *AwsCloudWatchAlarmDetails

SetAlarmArn sets the AlarmArn field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmConfigurationUpdatedTimestamp added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetAlarmConfigurationUpdatedTimestamp(v string) *AwsCloudWatchAlarmDetails

SetAlarmConfigurationUpdatedTimestamp sets the AlarmConfigurationUpdatedTimestamp field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmDescription added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetAlarmDescription(v string) *AwsCloudWatchAlarmDetails

SetAlarmDescription sets the AlarmDescription field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmName added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetAlarmName(v string) *AwsCloudWatchAlarmDetails

SetAlarmName sets the AlarmName field's value.

func (*AwsCloudWatchAlarmDetails) SetComparisonOperator added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetComparisonOperator(v string) *AwsCloudWatchAlarmDetails

SetComparisonOperator sets the ComparisonOperator field's value.

func (*AwsCloudWatchAlarmDetails) SetDatapointsToAlarm added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetDatapointsToAlarm(v int64) *AwsCloudWatchAlarmDetails

SetDatapointsToAlarm sets the DatapointsToAlarm field's value.

func (*AwsCloudWatchAlarmDetails) SetDimensions added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetDimensions(v []*AwsCloudWatchAlarmDimensionsDetails) *AwsCloudWatchAlarmDetails

SetDimensions sets the Dimensions field's value.

func (*AwsCloudWatchAlarmDetails) SetEvaluateLowSampleCountPercentile added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetEvaluateLowSampleCountPercentile(v string) *AwsCloudWatchAlarmDetails

SetEvaluateLowSampleCountPercentile sets the EvaluateLowSampleCountPercentile field's value.

func (*AwsCloudWatchAlarmDetails) SetEvaluationPeriods added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetEvaluationPeriods(v int64) *AwsCloudWatchAlarmDetails

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*AwsCloudWatchAlarmDetails) SetExtendedStatistic added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetExtendedStatistic(v string) *AwsCloudWatchAlarmDetails

SetExtendedStatistic sets the ExtendedStatistic field's value.

func (*AwsCloudWatchAlarmDetails) SetInsufficientDataActions added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetInsufficientDataActions(v []*string) *AwsCloudWatchAlarmDetails

SetInsufficientDataActions sets the InsufficientDataActions field's value.

func (*AwsCloudWatchAlarmDetails) SetMetricName added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetMetricName(v string) *AwsCloudWatchAlarmDetails

SetMetricName sets the MetricName field's value.

func (*AwsCloudWatchAlarmDetails) SetNamespace added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetNamespace(v string) *AwsCloudWatchAlarmDetails

SetNamespace sets the Namespace field's value.

func (*AwsCloudWatchAlarmDetails) SetOkActions added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetOkActions(v []*string) *AwsCloudWatchAlarmDetails

SetOkActions sets the OkActions field's value.

func (*AwsCloudWatchAlarmDetails) SetPeriod added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetPeriod(v int64) *AwsCloudWatchAlarmDetails

SetPeriod sets the Period field's value.

func (*AwsCloudWatchAlarmDetails) SetStatistic added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetStatistic(v string) *AwsCloudWatchAlarmDetails

SetStatistic sets the Statistic field's value.

func (*AwsCloudWatchAlarmDetails) SetThreshold added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetThreshold(v float64) *AwsCloudWatchAlarmDetails

SetThreshold sets the Threshold field's value.

func (*AwsCloudWatchAlarmDetails) SetThresholdMetricId added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetThresholdMetricId(v string) *AwsCloudWatchAlarmDetails

SetThresholdMetricId sets the ThresholdMetricId field's value.

func (*AwsCloudWatchAlarmDetails) SetTreatMissingData added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetTreatMissingData(v string) *AwsCloudWatchAlarmDetails

SetTreatMissingData sets the TreatMissingData field's value.

func (*AwsCloudWatchAlarmDetails) SetUnit added in v1.44.36 

func (s *AwsCloudWatchAlarmDetails) SetUnit(v string) *AwsCloudWatchAlarmDetails

SetUnit sets the Unit field's value.

func (AwsCloudWatchAlarmDetails) String added in v1.44.36 

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.44.36 

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.44.36 

func (s AwsCloudWatchAlarmDimensionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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

SetName sets the Name field's value.

func (*AwsCloudWatchAlarmDimensionsDetails) SetValue added in v1.44.36 

func (s *AwsCloudWatchAlarmDimensionsDetails) SetValue(v string) *AwsCloudWatchAlarmDimensionsDetails

SetValue sets the Value field's value.

func (AwsCloudWatchAlarmDimensionsDetails) String added in v1.44.36 

func (s AwsCloudWatchAlarmDimensionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsCodeBuildProjectArtifactsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetArtifactIdentifier(v string) *AwsCodeBuildProjectArtifactsDetails

SetArtifactIdentifier sets the ArtifactIdentifier field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetEncryptionDisabled added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetEncryptionDisabled(v bool) *AwsCodeBuildProjectArtifactsDetails

SetEncryptionDisabled sets the EncryptionDisabled field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetLocation added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetLocation(v string) *AwsCodeBuildProjectArtifactsDetails

SetLocation sets the Location field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetName added in v1.40.59 

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

SetName sets the Name field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetNamespaceType added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetNamespaceType(v string) *AwsCodeBuildProjectArtifactsDetails

SetNamespaceType sets the NamespaceType field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetOverrideArtifactName added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetOverrideArtifactName(v bool) *AwsCodeBuildProjectArtifactsDetails

SetOverrideArtifactName sets the OverrideArtifactName field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetPackaging added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetPackaging(v string) *AwsCodeBuildProjectArtifactsDetails

SetPackaging sets the Packaging field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetPath added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetPath(v string) *AwsCodeBuildProjectArtifactsDetails

SetPath sets the Path field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetType added in v1.40.59 

func (s *AwsCodeBuildProjectArtifactsDetails) SetType(v string) *AwsCodeBuildProjectArtifactsDetails

SetType sets the Type field's value.

func (AwsCodeBuildProjectArtifactsDetails) String added in v1.40.59 

func (s AwsCodeBuildProjectArtifactsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.40.59 

func (s *AwsCodeBuildProjectDetails) SetArtifacts(v []*AwsCodeBuildProjectArtifactsDetails) *AwsCodeBuildProjectDetails

SetArtifacts sets the Artifacts field's value.

func (*AwsCodeBuildProjectDetails) SetEncryptionKey added in v1.28.11 

func (s *AwsCodeBuildProjectDetails) SetEncryptionKey(v string) *AwsCodeBuildProjectDetails

SetEncryptionKey sets the EncryptionKey field's value.

func (*AwsCodeBuildProjectDetails) SetEnvironment added in v1.28.11 

func (s *AwsCodeBuildProjectDetails) SetEnvironment(v *AwsCodeBuildProjectEnvironment) *AwsCodeBuildProjectDetails

SetEnvironment sets the Environment field's value.

func (*AwsCodeBuildProjectDetails) SetLogsConfig added in v1.40.59 

func (s *AwsCodeBuildProjectDetails) SetLogsConfig(v *AwsCodeBuildProjectLogsConfigDetails) *AwsCodeBuildProjectDetails

SetLogsConfig sets the LogsConfig field's value.

func (*AwsCodeBuildProjectDetails) SetName added in v1.28.11 

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

SetName sets the Name field's value.

func (*AwsCodeBuildProjectDetails) SetSecondaryArtifacts added in v1.43.33 

func (s *AwsCodeBuildProjectDetails) SetSecondaryArtifacts(v []*AwsCodeBuildProjectArtifactsDetails) *AwsCodeBuildProjectDetails

SetSecondaryArtifacts sets the SecondaryArtifacts field's value.

func (*AwsCodeBuildProjectDetails) SetServiceRole added in v1.28.11 

func (s *AwsCodeBuildProjectDetails) SetServiceRole(v string) *AwsCodeBuildProjectDetails

SetServiceRole sets the ServiceRole field's value.

func (*AwsCodeBuildProjectDetails) SetSource added in v1.28.11 

func (s *AwsCodeBuildProjectDetails) SetSource(v *AwsCodeBuildProjectSource) *AwsCodeBuildProjectDetails

SetSource sets the Source field's value.

func (*AwsCodeBuildProjectDetails) SetVpcConfig added in v1.28.11 

func (s *AwsCodeBuildProjectDetails) SetVpcConfig(v *AwsCodeBuildProjectVpcConfig) *AwsCodeBuildProjectDetails

SetVpcConfig sets the VpcConfig field's value.

func (AwsCodeBuildProjectDetails) String added in v1.28.11 

func (s AwsCodeBuildProjectDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsCodeBuildProjectEnvironment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsCodeBuildProjectEnvironment) SetCertificate(v string) *AwsCodeBuildProjectEnvironment

SetCertificate sets the Certificate field's value.

func (*AwsCodeBuildProjectEnvironment) SetEnvironmentVariables added in v1.40.59 

func (s *AwsCodeBuildProjectEnvironment) SetEnvironmentVariables(v []*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) *AwsCodeBuildProjectEnvironment

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*AwsCodeBuildProjectEnvironment) SetImagePullCredentialsType added in v1.28.11 

func (s *AwsCodeBuildProjectEnvironment) SetImagePullCredentialsType(v string) *AwsCodeBuildProjectEnvironment

SetImagePullCredentialsType sets the ImagePullCredentialsType field's value.

func (*AwsCodeBuildProjectEnvironment) SetPrivilegedMode added in v1.40.59 

func (s *AwsCodeBuildProjectEnvironment) SetPrivilegedMode(v bool) *AwsCodeBuildProjectEnvironment

SetPrivilegedMode sets the PrivilegedMode field's value.

func (*AwsCodeBuildProjectEnvironment) SetRegistryCredential added in v1.28.11 

func (s *AwsCodeBuildProjectEnvironment) SetRegistryCredential(v *AwsCodeBuildProjectEnvironmentRegistryCredential) *AwsCodeBuildProjectEnvironment

SetRegistryCredential sets the RegistryCredential field's value.

func (*AwsCodeBuildProjectEnvironment) SetType added in v1.28.11 

func (s *AwsCodeBuildProjectEnvironment) SetType(v string) *AwsCodeBuildProjectEnvironment

SetType sets the Type field's value.

func (AwsCodeBuildProjectEnvironment) String added in v1.28.11 

func (s AwsCodeBuildProjectEnvironment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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

SetName sets the Name field's value.

func (*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetType added in v1.40.59 

func (s *AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetType(v string) *AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails

SetType sets the Type field's value.

func (*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetValue added in v1.40.59 

func (s *AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetValue(v string) *AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails

SetValue sets the Value field's value.

func (AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) String added in v1.40.59 

func (s AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsCodeBuildProjectEnvironmentRegistryCredential) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsCodeBuildProjectEnvironmentRegistryCredential) SetCredential(v string) *AwsCodeBuildProjectEnvironmentRegistryCredential

SetCredential sets the Credential field's value.

func (*AwsCodeBuildProjectEnvironmentRegistryCredential) SetCredentialProvider added in v1.28.11 

func (s *AwsCodeBuildProjectEnvironmentRegistryCredential) SetCredentialProvider(v string) *AwsCodeBuildProjectEnvironmentRegistryCredential

SetCredentialProvider sets the CredentialProvider field's value.

func (AwsCodeBuildProjectEnvironmentRegistryCredential) String added in v1.28.11 

func (s AwsCodeBuildProjectEnvironmentRegistryCredential) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetGroupName(v string) *AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails

SetGroupName sets the GroupName field's value.

func (*AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetStatus added in v1.40.59 

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

SetStatus sets the Status field's value.

func (*AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetStreamName added in v1.40.59 

func (s *AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetStreamName(v string) *AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails

SetStreamName sets the StreamName field's value.

func (AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) String added in v1.40.59 

func (s AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsCodeBuildProjectLogsConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsCodeBuildProjectLogsConfigDetails) SetCloudWatchLogs(v *AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) *AwsCodeBuildProjectLogsConfigDetails

SetCloudWatchLogs sets the CloudWatchLogs field's value.

func (*AwsCodeBuildProjectLogsConfigDetails) SetS3Logs added in v1.40.59 

func (s *AwsCodeBuildProjectLogsConfigDetails) SetS3Logs(v *AwsCodeBuildProjectLogsConfigS3LogsDetails) *AwsCodeBuildProjectLogsConfigDetails

SetS3Logs sets the S3Logs field's value.

func (AwsCodeBuildProjectLogsConfigDetails) String added in v1.40.59 

func (s AwsCodeBuildProjectLogsConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsCodeBuildProjectLogsConfigS3LogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsCodeBuildProjectLogsConfigS3LogsDetails) SetEncryptionDisabled(v bool) *AwsCodeBuildProjectLogsConfigS3LogsDetails

SetEncryptionDisabled sets the EncryptionDisabled field's value.

func (*AwsCodeBuildProjectLogsConfigS3LogsDetails) SetLocation added in v1.40.59 

func (s *AwsCodeBuildProjectLogsConfigS3LogsDetails) SetLocation(v string) *AwsCodeBuildProjectLogsConfigS3LogsDetails

SetLocation sets the Location field's value.

func (*AwsCodeBuildProjectLogsConfigS3LogsDetails) SetStatus added in v1.40.59 

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

SetStatus sets the Status field's value.

func (AwsCodeBuildProjectLogsConfigS3LogsDetails) String added in v1.40.59 

func (s AwsCodeBuildProjectLogsConfigS3LogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsCodeBuildProjectSource) SetGitCloneDepth(v int64) *AwsCodeBuildProjectSource

SetGitCloneDepth sets the GitCloneDepth field's value.

func (*AwsCodeBuildProjectSource) SetInsecureSsl added in v1.28.11 

func (s *AwsCodeBuildProjectSource) SetInsecureSsl(v bool) *AwsCodeBuildProjectSource

SetInsecureSsl sets the InsecureSsl field's value.

func (*AwsCodeBuildProjectSource) SetLocation added in v1.28.11 

func (s *AwsCodeBuildProjectSource) SetLocation(v string) *AwsCodeBuildProjectSource

SetLocation sets the Location field's value.

func (*AwsCodeBuildProjectSource) SetType added in v1.28.11 

func (s *AwsCodeBuildProjectSource) SetType(v string) *AwsCodeBuildProjectSource

SetType sets the Type field's value.

func (AwsCodeBuildProjectSource) String added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsCodeBuildProjectVpcConfig) SetSecurityGroupIds(v []*string) *AwsCodeBuildProjectVpcConfig

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsCodeBuildProjectVpcConfig) SetSubnets added in v1.28.11 

func (s *AwsCodeBuildProjectVpcConfig) SetSubnets(v []*string) *AwsCodeBuildProjectVpcConfig

SetSubnets sets the Subnets field's value.

func (*AwsCodeBuildProjectVpcConfig) SetVpcId added in v1.28.11 

func (s *AwsCodeBuildProjectVpcConfig) SetVpcId(v string) *AwsCodeBuildProjectVpcConfig

SetVpcId sets the VpcId field's value.

func (AwsCodeBuildProjectVpcConfig) String added in v1.28.11 

func (s AwsCodeBuildProjectVpcConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsCorsConfiguration) SetAllowCredentials(v bool) *AwsCorsConfiguration

SetAllowCredentials sets the AllowCredentials field's value.

func (*AwsCorsConfiguration) SetAllowHeaders added in v1.35.0 

func (s *AwsCorsConfiguration) SetAllowHeaders(v []*string) *AwsCorsConfiguration

SetAllowHeaders sets the AllowHeaders field's value.

func (*AwsCorsConfiguration) SetAllowMethods added in v1.35.0 

func (s *AwsCorsConfiguration) SetAllowMethods(v []*string) *AwsCorsConfiguration

SetAllowMethods sets the AllowMethods field's value.

func (*AwsCorsConfiguration) SetAllowOrigins added in v1.35.0 

func (s *AwsCorsConfiguration) SetAllowOrigins(v []*string) *AwsCorsConfiguration

SetAllowOrigins sets the AllowOrigins field's value.

func (*AwsCorsConfiguration) SetExposeHeaders added in v1.35.0 

func (s *AwsCorsConfiguration) SetExposeHeaders(v []*string) *AwsCorsConfiguration

SetExposeHeaders sets the ExposeHeaders field's value.

func (*AwsCorsConfiguration) SetMaxAge added in v1.35.0 

func (s *AwsCorsConfiguration) SetMaxAge(v int64) *AwsCorsConfiguration

SetMaxAge sets the MaxAge field's value.

func (AwsCorsConfiguration) String added in v1.35.0 

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 AwsDmsEndpointDetails added in v1.45.23 

type AwsDmsEndpointDetails struct {

	// The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections
	// between the DMS endpoint and the replication instance.
	CertificateArn *string `type:"string"`

	// The name of the endpoint database.
	DatabaseName *string `type:"string"`

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

	// The database endpoint identifier.
	EndpointIdentifier *string `type:"string"`

	// The type of endpoint. Valid values are source and target.
	EndpointType *string `type:"string"`

	// The type of engine for the endpoint, depending on the EndpointType value.
	EngineName *string `type:"string"`

	// A value that can be used for cross-account validation.
	ExternalId *string `type:"string"`

	// Additional attributes associated with the connection.
	ExtraConnectionAttributes *string `type:"string"`

	// An DMS key identifier that is used to encrypt the connection parameters for
	// the endpoint. If you don't specify a value for the KmsKeyId parameter, then
	// DMS uses your default encryption key. KMS creates the default encryption
	// key for your Amazon Web Services account. Your Amazon Web Services account
	// has a different default encryption key for each Amazon Web Services Region.
	KmsKeyId *string `type:"string"`

	// The port used to access the endpoint.
	Port *int64 `type:"integer"`

	// The name of the server where the endpoint database resides.
	ServerName *string `type:"string"`

	// The SSL mode used to connect to the endpoint. The default is none.
	SslMode *string `type:"string"`

	// The user name to be used to log in to the endpoint database.
	Username *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.

func (AwsDmsEndpointDetails) GoString added in v1.45.23 

func (s AwsDmsEndpointDetails) GoString() string

GoString returns the string representation.

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

func (*AwsDmsEndpointDetails) SetCertificateArn added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetCertificateArn(v string) *AwsDmsEndpointDetails

SetCertificateArn sets the CertificateArn field's value.

func (*AwsDmsEndpointDetails) SetDatabaseName added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetDatabaseName(v string) *AwsDmsEndpointDetails

SetDatabaseName sets the DatabaseName field's value.

func (*AwsDmsEndpointDetails) SetEndpointArn added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetEndpointArn(v string) *AwsDmsEndpointDetails

SetEndpointArn sets the EndpointArn field's value.

func (*AwsDmsEndpointDetails) SetEndpointIdentifier added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetEndpointIdentifier(v string) *AwsDmsEndpointDetails

SetEndpointIdentifier sets the EndpointIdentifier field's value.

func (*AwsDmsEndpointDetails) SetEndpointType added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetEndpointType(v string) *AwsDmsEndpointDetails

SetEndpointType sets the EndpointType field's value.

func (*AwsDmsEndpointDetails) SetEngineName added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetEngineName(v string) *AwsDmsEndpointDetails

SetEngineName sets the EngineName field's value.

func (*AwsDmsEndpointDetails) SetExternalId added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetExternalId(v string) *AwsDmsEndpointDetails

SetExternalId sets the ExternalId field's value.

func (*AwsDmsEndpointDetails) SetExtraConnectionAttributes added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetExtraConnectionAttributes(v string) *AwsDmsEndpointDetails

SetExtraConnectionAttributes sets the ExtraConnectionAttributes field's value.

func (*AwsDmsEndpointDetails) SetKmsKeyId added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetKmsKeyId(v string) *AwsDmsEndpointDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsDmsEndpointDetails) SetPort added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetPort(v int64) *AwsDmsEndpointDetails

SetPort sets the Port field's value.

func (*AwsDmsEndpointDetails) SetServerName added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetServerName(v string) *AwsDmsEndpointDetails

SetServerName sets the ServerName field's value.

func (*AwsDmsEndpointDetails) SetSslMode added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetSslMode(v string) *AwsDmsEndpointDetails

SetSslMode sets the SslMode field's value.

func (*AwsDmsEndpointDetails) SetUsername added in v1.45.23 

func (s *AwsDmsEndpointDetails) SetUsername(v string) *AwsDmsEndpointDetails

SetUsername sets the Username field's value.

func (AwsDmsEndpointDetails) String added in v1.45.23 

func (s AwsDmsEndpointDetails) String() string

String returns the string representation.

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

type AwsDmsReplicationInstanceDetails added in v1.45.23 

type AwsDmsReplicationInstanceDetails struct {

	// The amount of storage (in gigabytes) that is allocated for the replication
	// instance.
	AllocatedStorage *int64 `type:"integer"`

	// Indicates whether minor engine upgrades are applied automatically to the
	// replication instance during the maintenance window.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone that the replication instance is created in. The default
	// value is a random, system-chosen Availability Zone in the endpoint's Amazon
	// Web Services Region, such as us-east-1d.
	AvailabilityZone *string `type:"string"`

	// The engine version number of the replication instance. If an engine version
	// number is not specified when a replication instance is created, the default
	// is the latest engine version available.
	EngineVersion *string `type:"string"`

	// An KMS key identifier that is used to encrypt the data on the replication
	// instance. If you don't specify a value for the KmsKeyId parameter, DMS uses
	// your default encryption key. KMS creates the default encryption key for your
	// Amazon Web Services account. Your Amazon Web Services account has a different
	// default encryption key for each Amazon Web Services Region.
	KmsKeyId *string `type:"string"`

	// Specifies whether the replication instance is deployed across multiple Availability
	// Zones (AZs). You can't set the AvailabilityZone parameter if the MultiAZ
	// parameter is set to true.
	MultiAZ *bool `type:"boolean"`

	// The maintenance window times for the replication instance. Upgrades to the
	// replication instance are performed during this time.
	PreferredMaintenanceWindow *string `type:"string"`

	// Specifies the accessibility options for the replication instance. A value
	// of true represents an instance with a public IP address. A value of false
	// represents an instance with a private IP address. The default value is true.
	PubliclyAccessible *bool `type:"boolean"`

	// The compute and memory capacity of the replication instance as defined for
	// the specified replication instance class.
	ReplicationInstanceClass *string `type:"string"`

	// The replication instance identifier.
	ReplicationInstanceIdentifier *string `type:"string"`

	// The subnet group for the replication instance.
	ReplicationSubnetGroup *AwsDmsReplicationInstanceReplicationSubnetGroupDetails `type:"structure"`

	// The virtual private cloud (VPC) security group for the replication instance.
	VpcSecurityGroups []*AwsDmsReplicationInstanceVpcSecurityGroupsDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides details about an Database Migration Service (DMS) replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.

func (AwsDmsReplicationInstanceDetails) GoString added in v1.45.23 

func (s AwsDmsReplicationInstanceDetails) GoString() string

GoString returns the string representation.

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

func (*AwsDmsReplicationInstanceDetails) SetAllocatedStorage added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetAllocatedStorage(v int64) *AwsDmsReplicationInstanceDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsDmsReplicationInstanceDetails) SetAutoMinorVersionUpgrade added in v1.45.23 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*AwsDmsReplicationInstanceDetails) SetAvailabilityZone added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetAvailabilityZone(v string) *AwsDmsReplicationInstanceDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsDmsReplicationInstanceDetails) SetEngineVersion added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetEngineVersion(v string) *AwsDmsReplicationInstanceDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsDmsReplicationInstanceDetails) SetKmsKeyId added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetKmsKeyId(v string) *AwsDmsReplicationInstanceDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsDmsReplicationInstanceDetails) SetMultiAZ added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetMultiAZ(v bool) *AwsDmsReplicationInstanceDetails

SetMultiAZ sets the MultiAZ field's value.

func (*AwsDmsReplicationInstanceDetails) SetPreferredMaintenanceWindow added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetPreferredMaintenanceWindow(v string) *AwsDmsReplicationInstanceDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsDmsReplicationInstanceDetails) SetPubliclyAccessible added in v1.45.23 

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsDmsReplicationInstanceDetails) SetReplicationInstanceClass added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetReplicationInstanceClass(v string) *AwsDmsReplicationInstanceDetails

SetReplicationInstanceClass sets the ReplicationInstanceClass field's value.

func (*AwsDmsReplicationInstanceDetails) SetReplicationInstanceIdentifier added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetReplicationInstanceIdentifier(v string) *AwsDmsReplicationInstanceDetails

SetReplicationInstanceIdentifier sets the ReplicationInstanceIdentifier field's value.

func (*AwsDmsReplicationInstanceDetails) SetReplicationSubnetGroup added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetReplicationSubnetGroup(v *AwsDmsReplicationInstanceReplicationSubnetGroupDetails) *AwsDmsReplicationInstanceDetails

SetReplicationSubnetGroup sets the ReplicationSubnetGroup field's value.

func (*AwsDmsReplicationInstanceDetails) SetVpcSecurityGroups added in v1.45.23 

func (s *AwsDmsReplicationInstanceDetails) SetVpcSecurityGroups(v []*AwsDmsReplicationInstanceVpcSecurityGroupsDetails) *AwsDmsReplicationInstanceDetails

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsDmsReplicationInstanceDetails) String added in v1.45.23 

func (s AwsDmsReplicationInstanceDetails) String() string

String returns the string representation.

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

type AwsDmsReplicationInstanceReplicationSubnetGroupDetails added in v1.45.23 

type AwsDmsReplicationInstanceReplicationSubnetGroupDetails struct {

	// The identifier of the replication subnet group.
	ReplicationSubnetGroupIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the replication subnet group.

func (AwsDmsReplicationInstanceReplicationSubnetGroupDetails) GoString added in v1.45.23 

func (s AwsDmsReplicationInstanceReplicationSubnetGroupDetails) GoString() string

GoString returns the string representation.

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

func (*AwsDmsReplicationInstanceReplicationSubnetGroupDetails) SetReplicationSubnetGroupIdentifier added in v1.45.23 

func (s *AwsDmsReplicationInstanceReplicationSubnetGroupDetails) SetReplicationSubnetGroupIdentifier(v string) *AwsDmsReplicationInstanceReplicationSubnetGroupDetails

SetReplicationSubnetGroupIdentifier sets the ReplicationSubnetGroupIdentifier field's value.

func (AwsDmsReplicationInstanceReplicationSubnetGroupDetails) String added in v1.45.23 

func (s AwsDmsReplicationInstanceReplicationSubnetGroupDetails) String() string

String returns the string representation.

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

type AwsDmsReplicationInstanceVpcSecurityGroupsDetails added in v1.45.23 

type AwsDmsReplicationInstanceVpcSecurityGroupsDetails struct {

	// The identifier of the VPC security group that’s associated with the replication
	// instance.
	VpcSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the virtual private cloud (VPC) security group that’s associated with the replication instance.

func (AwsDmsReplicationInstanceVpcSecurityGroupsDetails) GoString added in v1.45.23 

func (s AwsDmsReplicationInstanceVpcSecurityGroupsDetails) GoString() string

GoString returns the string representation.

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

func (*AwsDmsReplicationInstanceVpcSecurityGroupsDetails) SetVpcSecurityGroupId added in v1.45.23 

func (s *AwsDmsReplicationInstanceVpcSecurityGroupsDetails) SetVpcSecurityGroupId(v string) *AwsDmsReplicationInstanceVpcSecurityGroupsDetails

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (AwsDmsReplicationInstanceVpcSecurityGroupsDetails) String added in v1.45.23 

func (s AwsDmsReplicationInstanceVpcSecurityGroupsDetails) String() string

String returns the string representation.

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

type AwsDmsReplicationTaskDetails added in v1.45.23 

type AwsDmsReplicationTaskDetails struct {

	// Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition
	// or CCdcStartTime specifies when you want a CDC operation to start. Only a
	// value for one of these fields is included.
	CdcStartPosition *string `type:"string"`

	// Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime
	// specifies when you want a CDC operation to start. Only a value for one of
	// these fields is included.
	CdcStartTime *string `type:"string"`

	// Indicates when you want a CDC operation to stop. The value can be either
	// server time or commit time.
	CdcStopPosition *string `type:"string"`

	// The identifier of the replication task.
	Id *string `type:"string"`

	// The migration type.
	MigrationType *string `type:"string"`

	// The Amazon Resource Name (ARN) of a replication instance.
	ReplicationInstanceArn *string `type:"string"`

	// The user-defined replication task identifier or name.
	ReplicationTaskIdentifier *string `type:"string"`

	// The settings for the replication task.
	ReplicationTaskSettings *string `type:"string"`

	// A display name for the resource identifier at the end of the EndpointArn
	// response parameter. If you don't specify a ResourceIdentifier value, DMS
	// generates a default identifier value for the end of EndpointArn.
	ResourceIdentifier *string `type:"string"`

	// The ARN of the source endpoint.
	SourceEndpointArn *string `type:"string"`

	// The table mappings for the replication task, in JSON format.
	TableMappings *string `type:"string"`

	// The ARN of the target endpoint.
	TargetEndpointArn *string `type:"string"`

	// Supplemental information that the task requires to migrate the data for certain
	// source and target endpoints.
	TaskData *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Database Migration Service (DMS) replication task. A replication task moves a set of data from the source endpoint to the target endpoint.

func (AwsDmsReplicationTaskDetails) GoString added in v1.45.23 

func (s AwsDmsReplicationTaskDetails) GoString() string

GoString returns the string representation.

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

func (*AwsDmsReplicationTaskDetails) SetCdcStartPosition added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetCdcStartPosition(v string) *AwsDmsReplicationTaskDetails

SetCdcStartPosition sets the CdcStartPosition field's value.

func (*AwsDmsReplicationTaskDetails) SetCdcStartTime added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetCdcStartTime(v string) *AwsDmsReplicationTaskDetails

SetCdcStartTime sets the CdcStartTime field's value.

func (*AwsDmsReplicationTaskDetails) SetCdcStopPosition added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetCdcStopPosition(v string) *AwsDmsReplicationTaskDetails

SetCdcStopPosition sets the CdcStopPosition field's value.

func (*AwsDmsReplicationTaskDetails) SetId added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetId(v string) *AwsDmsReplicationTaskDetails

SetId sets the Id field's value.

func (*AwsDmsReplicationTaskDetails) SetMigrationType added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetMigrationType(v string) *AwsDmsReplicationTaskDetails

SetMigrationType sets the MigrationType field's value.

func (*AwsDmsReplicationTaskDetails) SetReplicationInstanceArn added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetReplicationInstanceArn(v string) *AwsDmsReplicationTaskDetails

SetReplicationInstanceArn sets the ReplicationInstanceArn field's value.

func (*AwsDmsReplicationTaskDetails) SetReplicationTaskIdentifier added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetReplicationTaskIdentifier(v string) *AwsDmsReplicationTaskDetails

SetReplicationTaskIdentifier sets the ReplicationTaskIdentifier field's value.

func (*AwsDmsReplicationTaskDetails) SetReplicationTaskSettings added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetReplicationTaskSettings(v string) *AwsDmsReplicationTaskDetails

SetReplicationTaskSettings sets the ReplicationTaskSettings field's value.

func (*AwsDmsReplicationTaskDetails) SetResourceIdentifier added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetResourceIdentifier(v string) *AwsDmsReplicationTaskDetails

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*AwsDmsReplicationTaskDetails) SetSourceEndpointArn added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetSourceEndpointArn(v string) *AwsDmsReplicationTaskDetails

SetSourceEndpointArn sets the SourceEndpointArn field's value.

func (*AwsDmsReplicationTaskDetails) SetTableMappings added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetTableMappings(v string) *AwsDmsReplicationTaskDetails

SetTableMappings sets the TableMappings field's value.

func (*AwsDmsReplicationTaskDetails) SetTargetEndpointArn added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetTargetEndpointArn(v string) *AwsDmsReplicationTaskDetails

SetTargetEndpointArn sets the TargetEndpointArn field's value.

func (*AwsDmsReplicationTaskDetails) SetTaskData added in v1.45.23 

func (s *AwsDmsReplicationTaskDetails) SetTaskData(v string) *AwsDmsReplicationTaskDetails

SetTaskData sets the TaskData field's value.

func (AwsDmsReplicationTaskDetails) String added in v1.45.23 

func (s AwsDmsReplicationTaskDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsDynamoDbTableAttributeDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableAttributeDefinition) SetAttributeName(v string) *AwsDynamoDbTableAttributeDefinition

SetAttributeName sets the AttributeName field's value.

func (*AwsDynamoDbTableAttributeDefinition) SetAttributeType added in v1.34.7 

func (s *AwsDynamoDbTableAttributeDefinition) SetAttributeType(v string) *AwsDynamoDbTableAttributeDefinition

SetAttributeType sets the AttributeType field's value.

func (AwsDynamoDbTableAttributeDefinition) String added in v1.34.7 

func (s AwsDynamoDbTableAttributeDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	LastUpdateToPayPerRequestDateTime *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the billing for read/write capacity on the table.

func (AwsDynamoDbTableBillingModeSummary) GoString added in v1.34.7 

func (s AwsDynamoDbTableBillingModeSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableBillingModeSummary) SetBillingMode(v string) *AwsDynamoDbTableBillingModeSummary

SetBillingMode sets the BillingMode field's value.

func (*AwsDynamoDbTableBillingModeSummary) SetLastUpdateToPayPerRequestDateTime added in v1.34.7 

func (s *AwsDynamoDbTableBillingModeSummary) SetLastUpdateToPayPerRequestDateTime(v string) *AwsDynamoDbTableBillingModeSummary

SetLastUpdateToPayPerRequestDateTime sets the LastUpdateToPayPerRequestDateTime field's value.

func (AwsDynamoDbTableBillingModeSummary) String added in v1.34.7 

func (s AwsDynamoDbTableBillingModeSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	CreationDateTime *string `type:"string"`

	// Indicates whether deletion protection is to be enabled (true) or disabled
	// (false) on the table.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// 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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetAttributeDefinitions(v []*AwsDynamoDbTableAttributeDefinition) *AwsDynamoDbTableDetails

SetAttributeDefinitions sets the AttributeDefinitions field's value.

func (*AwsDynamoDbTableDetails) SetBillingModeSummary added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetBillingModeSummary(v *AwsDynamoDbTableBillingModeSummary) *AwsDynamoDbTableDetails

SetBillingModeSummary sets the BillingModeSummary field's value.

func (*AwsDynamoDbTableDetails) SetCreationDateTime added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetCreationDateTime(v string) *AwsDynamoDbTableDetails

SetCreationDateTime sets the CreationDateTime field's value.

func (*AwsDynamoDbTableDetails) SetDeletionProtectionEnabled added in v1.49.0 

func (s *AwsDynamoDbTableDetails) SetDeletionProtectionEnabled(v bool) *AwsDynamoDbTableDetails

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*AwsDynamoDbTableDetails) SetGlobalSecondaryIndexes added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetGlobalSecondaryIndexes(v []*AwsDynamoDbTableGlobalSecondaryIndex) *AwsDynamoDbTableDetails

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*AwsDynamoDbTableDetails) SetGlobalTableVersion added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetGlobalTableVersion(v string) *AwsDynamoDbTableDetails

SetGlobalTableVersion sets the GlobalTableVersion field's value.

func (*AwsDynamoDbTableDetails) SetItemCount added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetItemCount(v int64) *AwsDynamoDbTableDetails

SetItemCount sets the ItemCount field's value.

func (*AwsDynamoDbTableDetails) SetKeySchema added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetKeySchema(v []*AwsDynamoDbTableKeySchema) *AwsDynamoDbTableDetails

SetKeySchema sets the KeySchema field's value.

func (*AwsDynamoDbTableDetails) SetLatestStreamArn added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetLatestStreamArn(v string) *AwsDynamoDbTableDetails

SetLatestStreamArn sets the LatestStreamArn field's value.

func (*AwsDynamoDbTableDetails) SetLatestStreamLabel added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetLatestStreamLabel(v string) *AwsDynamoDbTableDetails

SetLatestStreamLabel sets the LatestStreamLabel field's value.

func (*AwsDynamoDbTableDetails) SetLocalSecondaryIndexes added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetLocalSecondaryIndexes(v []*AwsDynamoDbTableLocalSecondaryIndex) *AwsDynamoDbTableDetails

SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.

func (*AwsDynamoDbTableDetails) SetProvisionedThroughput added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetProvisionedThroughput(v *AwsDynamoDbTableProvisionedThroughput) *AwsDynamoDbTableDetails

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (*AwsDynamoDbTableDetails) SetReplicas added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetReplicas(v []*AwsDynamoDbTableReplica) *AwsDynamoDbTableDetails

SetReplicas sets the Replicas field's value.

func (*AwsDynamoDbTableDetails) SetRestoreSummary added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetRestoreSummary(v *AwsDynamoDbTableRestoreSummary) *AwsDynamoDbTableDetails

SetRestoreSummary sets the RestoreSummary field's value.

func (*AwsDynamoDbTableDetails) SetSseDescription added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetSseDescription(v *AwsDynamoDbTableSseDescription) *AwsDynamoDbTableDetails

SetSseDescription sets the SseDescription field's value.

func (*AwsDynamoDbTableDetails) SetStreamSpecification added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetStreamSpecification(v *AwsDynamoDbTableStreamSpecification) *AwsDynamoDbTableDetails

SetStreamSpecification sets the StreamSpecification field's value.

func (*AwsDynamoDbTableDetails) SetTableId added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetTableId(v string) *AwsDynamoDbTableDetails

SetTableId sets the TableId field's value.

func (*AwsDynamoDbTableDetails) SetTableName added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetTableName(v string) *AwsDynamoDbTableDetails

SetTableName sets the TableName field's value.

func (*AwsDynamoDbTableDetails) SetTableSizeBytes added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetTableSizeBytes(v int64) *AwsDynamoDbTableDetails

SetTableSizeBytes sets the TableSizeBytes field's value.

func (*AwsDynamoDbTableDetails) SetTableStatus added in v1.34.7 

func (s *AwsDynamoDbTableDetails) SetTableStatus(v string) *AwsDynamoDbTableDetails

SetTableStatus sets the TableStatus field's value.

func (AwsDynamoDbTableDetails) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsDynamoDbTableGlobalSecondaryIndex) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetBackfilling(v bool) *AwsDynamoDbTableGlobalSecondaryIndex

SetBackfilling sets the Backfilling field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexArn added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetIndexArn(v string) *AwsDynamoDbTableGlobalSecondaryIndex

SetIndexArn sets the IndexArn field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexName added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetIndexName(v string) *AwsDynamoDbTableGlobalSecondaryIndex

SetIndexName sets the IndexName field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexSizeBytes added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetIndexSizeBytes(v int64) *AwsDynamoDbTableGlobalSecondaryIndex

SetIndexSizeBytes sets the IndexSizeBytes field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexStatus added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetIndexStatus(v string) *AwsDynamoDbTableGlobalSecondaryIndex

SetIndexStatus sets the IndexStatus field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetItemCount added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetItemCount(v int64) *AwsDynamoDbTableGlobalSecondaryIndex

SetItemCount sets the ItemCount field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetKeySchema added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetKeySchema(v []*AwsDynamoDbTableKeySchema) *AwsDynamoDbTableGlobalSecondaryIndex

SetKeySchema sets the KeySchema field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetProjection added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetProjection(v *AwsDynamoDbTableProjection) *AwsDynamoDbTableGlobalSecondaryIndex

SetProjection sets the Projection field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetProvisionedThroughput added in v1.34.7 

func (s *AwsDynamoDbTableGlobalSecondaryIndex) SetProvisionedThroughput(v *AwsDynamoDbTableProvisionedThroughput) *AwsDynamoDbTableGlobalSecondaryIndex

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (AwsDynamoDbTableGlobalSecondaryIndex) String added in v1.34.7 

func (s AwsDynamoDbTableGlobalSecondaryIndex) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsDynamoDbTableKeySchema) SetAttributeName(v string) *AwsDynamoDbTableKeySchema

SetAttributeName sets the AttributeName field's value.

func (*AwsDynamoDbTableKeySchema) SetKeyType added in v1.34.7 

func (s *AwsDynamoDbTableKeySchema) SetKeyType(v string) *AwsDynamoDbTableKeySchema

SetKeyType sets the KeyType field's value.

func (AwsDynamoDbTableKeySchema) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsDynamoDbTableLocalSecondaryIndex) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableLocalSecondaryIndex) SetIndexArn(v string) *AwsDynamoDbTableLocalSecondaryIndex

SetIndexArn sets the IndexArn field's value.

func (*AwsDynamoDbTableLocalSecondaryIndex) SetIndexName added in v1.34.7 

func (s *AwsDynamoDbTableLocalSecondaryIndex) SetIndexName(v string) *AwsDynamoDbTableLocalSecondaryIndex

SetIndexName sets the IndexName field's value.

func (*AwsDynamoDbTableLocalSecondaryIndex) SetKeySchema added in v1.34.7 

func (s *AwsDynamoDbTableLocalSecondaryIndex) SetKeySchema(v []*AwsDynamoDbTableKeySchema) *AwsDynamoDbTableLocalSecondaryIndex

SetKeySchema sets the KeySchema field's value.

func (*AwsDynamoDbTableLocalSecondaryIndex) SetProjection added in v1.34.7 

func (s *AwsDynamoDbTableLocalSecondaryIndex) SetProjection(v *AwsDynamoDbTableProjection) *AwsDynamoDbTableLocalSecondaryIndex

SetProjection sets the Projection field's value.

func (AwsDynamoDbTableLocalSecondaryIndex) String added in v1.34.7 

func (s AwsDynamoDbTableLocalSecondaryIndex) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsDynamoDbTableProjection) SetNonKeyAttributes(v []*string) *AwsDynamoDbTableProjection

SetNonKeyAttributes sets the NonKeyAttributes field's value.

func (*AwsDynamoDbTableProjection) SetProjectionType added in v1.34.7 

func (s *AwsDynamoDbTableProjection) SetProjectionType(v string) *AwsDynamoDbTableProjection

SetProjectionType sets the ProjectionType field's value.

func (AwsDynamoDbTableProjection) String added in v1.34.7 

func (s AwsDynamoDbTableProjection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

type AwsDynamoDbTableProvisionedThroughput struct {

	// Indicates when the provisioned throughput was last decreased.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	LastDecreaseDateTime *string `type:"string"`

	// Indicates when the provisioned throughput was last increased.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

func (s AwsDynamoDbTableProvisionedThroughput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableProvisionedThroughput) SetLastDecreaseDateTime(v string) *AwsDynamoDbTableProvisionedThroughput

SetLastDecreaseDateTime sets the LastDecreaseDateTime field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetLastIncreaseDateTime added in v1.34.7 

func (s *AwsDynamoDbTableProvisionedThroughput) SetLastIncreaseDateTime(v string) *AwsDynamoDbTableProvisionedThroughput

SetLastIncreaseDateTime sets the LastIncreaseDateTime field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetNumberOfDecreasesToday added in v1.34.7 

func (s *AwsDynamoDbTableProvisionedThroughput) SetNumberOfDecreasesToday(v int64) *AwsDynamoDbTableProvisionedThroughput

SetNumberOfDecreasesToday sets the NumberOfDecreasesToday field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetReadCapacityUnits added in v1.34.7 

func (s *AwsDynamoDbTableProvisionedThroughput) SetReadCapacityUnits(v int64) *AwsDynamoDbTableProvisionedThroughput

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetWriteCapacityUnits added in v1.34.7 

func (s *AwsDynamoDbTableProvisionedThroughput) SetWriteCapacityUnits(v int64) *AwsDynamoDbTableProvisionedThroughput

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (AwsDynamoDbTableProvisionedThroughput) String added in v1.34.7 

func (s AwsDynamoDbTableProvisionedThroughput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsDynamoDbTableProvisionedThroughputOverride) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableProvisionedThroughputOverride) SetReadCapacityUnits(v int64) *AwsDynamoDbTableProvisionedThroughputOverride

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (AwsDynamoDbTableProvisionedThroughputOverride) String added in v1.34.7 

func (s AwsDynamoDbTableProvisionedThroughputOverride) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsDynamoDbTableReplica) SetGlobalSecondaryIndexes(v []*AwsDynamoDbTableReplicaGlobalSecondaryIndex) *AwsDynamoDbTableReplica

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*AwsDynamoDbTableReplica) SetKmsMasterKeyId added in v1.34.7 

func (s *AwsDynamoDbTableReplica) SetKmsMasterKeyId(v string) *AwsDynamoDbTableReplica

SetKmsMasterKeyId sets the KmsMasterKeyId field's value.

func (*AwsDynamoDbTableReplica) SetProvisionedThroughputOverride added in v1.34.7 

func (s *AwsDynamoDbTableReplica) SetProvisionedThroughputOverride(v *AwsDynamoDbTableProvisionedThroughputOverride) *AwsDynamoDbTableReplica

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*AwsDynamoDbTableReplica) SetRegionName added in v1.34.7 

func (s *AwsDynamoDbTableReplica) SetRegionName(v string) *AwsDynamoDbTableReplica

SetRegionName sets the RegionName field's value.

func (*AwsDynamoDbTableReplica) SetReplicaStatus added in v1.34.7 

func (s *AwsDynamoDbTableReplica) SetReplicaStatus(v string) *AwsDynamoDbTableReplica

SetReplicaStatus sets the ReplicaStatus field's value.

func (*AwsDynamoDbTableReplica) SetReplicaStatusDescription added in v1.34.7 

func (s *AwsDynamoDbTableReplica) SetReplicaStatusDescription(v string) *AwsDynamoDbTableReplica

SetReplicaStatusDescription sets the ReplicaStatusDescription field's value.

func (AwsDynamoDbTableReplica) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsDynamoDbTableReplicaGlobalSecondaryIndex) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableReplicaGlobalSecondaryIndex) SetIndexName(v string) *AwsDynamoDbTableReplicaGlobalSecondaryIndex

SetIndexName sets the IndexName field's value.

func (*AwsDynamoDbTableReplicaGlobalSecondaryIndex) SetProvisionedThroughputOverride added in v1.34.7 

func (s *AwsDynamoDbTableReplicaGlobalSecondaryIndex) SetProvisionedThroughputOverride(v *AwsDynamoDbTableProvisionedThroughputOverride) *AwsDynamoDbTableReplicaGlobalSecondaryIndex

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (AwsDynamoDbTableReplicaGlobalSecondaryIndex) String added in v1.34.7 

func (s AwsDynamoDbTableReplicaGlobalSecondaryIndex) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

type AwsDynamoDbTableRestoreSummary struct {

	// Indicates the point in time that the table was restored to.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

func (s AwsDynamoDbTableRestoreSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableRestoreSummary) SetRestoreDateTime(v string) *AwsDynamoDbTableRestoreSummary

SetRestoreDateTime sets the RestoreDateTime field's value.

func (*AwsDynamoDbTableRestoreSummary) SetRestoreInProgress added in v1.34.7 

func (s *AwsDynamoDbTableRestoreSummary) SetRestoreInProgress(v bool) *AwsDynamoDbTableRestoreSummary

SetRestoreInProgress sets the RestoreInProgress field's value.

func (*AwsDynamoDbTableRestoreSummary) SetSourceBackupArn added in v1.34.7 

func (s *AwsDynamoDbTableRestoreSummary) SetSourceBackupArn(v string) *AwsDynamoDbTableRestoreSummary

SetSourceBackupArn sets the SourceBackupArn field's value.

func (*AwsDynamoDbTableRestoreSummary) SetSourceTableArn added in v1.34.7 

func (s *AwsDynamoDbTableRestoreSummary) SetSourceTableArn(v string) *AwsDynamoDbTableRestoreSummary

SetSourceTableArn sets the SourceTableArn field's value.

func (AwsDynamoDbTableRestoreSummary) String added in v1.34.7 

func (s AwsDynamoDbTableRestoreSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

type AwsDynamoDbTableSseDescription struct {

	// If the key is inaccessible, the date and time when DynamoDB detected that
	// the key was inaccessible.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

func (s AwsDynamoDbTableSseDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableSseDescription) SetInaccessibleEncryptionDateTime(v string) *AwsDynamoDbTableSseDescription

SetInaccessibleEncryptionDateTime sets the InaccessibleEncryptionDateTime field's value.

func (*AwsDynamoDbTableSseDescription) SetKmsMasterKeyArn added in v1.34.7 

func (s *AwsDynamoDbTableSseDescription) SetKmsMasterKeyArn(v string) *AwsDynamoDbTableSseDescription

SetKmsMasterKeyArn sets the KmsMasterKeyArn field's value.

func (*AwsDynamoDbTableSseDescription) SetSseType added in v1.34.7 

func (s *AwsDynamoDbTableSseDescription) SetSseType(v string) *AwsDynamoDbTableSseDescription

SetSseType sets the SseType field's value.

func (*AwsDynamoDbTableSseDescription) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (AwsDynamoDbTableSseDescription) String added in v1.34.7 

func (s AwsDynamoDbTableSseDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsDynamoDbTableStreamSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsDynamoDbTableStreamSpecification) SetStreamEnabled(v bool) *AwsDynamoDbTableStreamSpecification

SetStreamEnabled sets the StreamEnabled field's value.

func (*AwsDynamoDbTableStreamSpecification) SetStreamViewType added in v1.34.7 

func (s *AwsDynamoDbTableStreamSpecification) SetStreamViewType(v string) *AwsDynamoDbTableStreamSpecification

SetStreamViewType sets the StreamViewType field's value.

func (AwsDynamoDbTableStreamSpecification) String added in v1.34.7 

func (s AwsDynamoDbTableStreamSpecification) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails struct {

	// The ID of the Active Directory used for authentication.
	DirectoryId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Active Directory that’s used to authenticate an Client VPN endpoint.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) SetDirectoryId added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) SetDirectoryId(v string) *AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails

SetDirectoryId sets the DirectoryId field's value.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointAuthenticationOptionsDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointAuthenticationOptionsDetails struct {

	// Information about the Active Directory, if applicable. With Active Directory
	// authentication, clients are authenticated against existing Active Directory
	// groups.
	ActiveDirectory *AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails `type:"structure"`

	// Information about the IAM SAML identity provider, if applicable.
	FederatedAuthentication *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails `type:"structure"`

	// Information about the authentication certificates, if applicable.
	MutualAuthentication *AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails `type:"structure"`

	// The authentication type used.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the authentication method used by the Client VPN endpoint.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetActiveDirectory added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetActiveDirectory(v *AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails) *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails

SetActiveDirectory sets the ActiveDirectory field's value.

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetFederatedAuthentication added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetFederatedAuthentication(v *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails

SetFederatedAuthentication sets the FederatedAuthentication field's value.

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetMutualAuthentication added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetMutualAuthentication(v *AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails

SetMutualAuthentication sets the MutualAuthentication field's value.

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetType added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) SetType(v string) *AwsEc2ClientVpnEndpointAuthenticationOptionsDetails

SetType sets the Type field's value.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails struct {

	// The Amazon Resource Name (ARN) of the IAM SAML identity provider.
	SamlProviderArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM SAML identity provider for the
	// self-service portal.
	SelfServiceSamlProviderArn *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the IAM SAML identity providers used for federated authentication.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) SetSamlProviderArn added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) SetSamlProviderArn(v string) *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails

SetSamlProviderArn sets the SamlProviderArn field's value.

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) SetSelfServiceSamlProviderArn added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) SetSelfServiceSamlProviderArn(v string) *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails

SetSelfServiceSamlProviderArn sets the SelfServiceSamlProviderArn field's value.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails struct {

	// The Amazon Resource Name (ARN) of the client certificate.
	ClientRootCertificateChain *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the client certificate used for authentication.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) SetClientRootCertificateChain added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) SetClientRootCertificateChain(v string) *AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails

SetClientRootCertificateChain sets the ClientRootCertificateChain field's value.

func (AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointClientConnectOptionsDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointClientConnectOptionsDetails struct {

	// Indicates whether client connect options are enabled.
	Enabled *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the Lambda function used for connection
	// authorization.
	LambdaFunctionArn *string `type:"string"`

	// The status of any updates to the client connect options.
	Status *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails `type:"structure"`
	// contains filtered or unexported fields
}

The options for managing connection authorization for new client connections.

func (AwsEc2ClientVpnEndpointClientConnectOptionsDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointClientConnectOptionsDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointClientConnectOptionsDetails) SetEnabled added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientConnectOptionsDetails) SetEnabled(v bool) *AwsEc2ClientVpnEndpointClientConnectOptionsDetails

SetEnabled sets the Enabled field's value.

func (*AwsEc2ClientVpnEndpointClientConnectOptionsDetails) SetLambdaFunctionArn added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientConnectOptionsDetails) SetLambdaFunctionArn(v string) *AwsEc2ClientVpnEndpointClientConnectOptionsDetails

SetLambdaFunctionArn sets the LambdaFunctionArn field's value.

func (*AwsEc2ClientVpnEndpointClientConnectOptionsDetails) SetStatus added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientConnectOptionsDetails) SetStatus(v *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) *AwsEc2ClientVpnEndpointClientConnectOptionsDetails

SetStatus sets the Status field's value.

func (AwsEc2ClientVpnEndpointClientConnectOptionsDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointClientConnectOptionsDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails struct {

	// The status code.
	Code *string `type:"string"`

	// The status message.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the status of the Client VPN endpoint attribute.

func (AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) SetCode added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) SetCode(v string) *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails

SetCode sets the Code field's value.

func (*AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) SetMessage added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) SetMessage(v string) *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails

SetMessage sets the Message field's value.

func (AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails struct {

	// Customizable text that will be displayed in a banner on Amazon Web Services
	// provided clients when a VPN session is established.
	BannerText *string `type:"string"`

	// Current state of text banner feature.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

func (AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) SetBannerText added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) SetBannerText(v string) *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails

SetBannerText sets the BannerText field's value.

func (*AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) SetEnabled added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) SetEnabled(v bool) *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails

SetEnabled sets the Enabled field's value.

func (AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointConnectionLogOptionsDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointConnectionLogOptionsDetails struct {

	// The name of the Amazon CloudWatch Logs log group to which connection logging
	// data is published.
	CloudwatchLogGroup *string `type:"string"`

	// The name of the Amazon CloudWatch Logs log stream to which connection logging
	// data is published.
	CloudwatchLogStream *string `type:"string"`

	// Indicates whether client connection logging is enabled for the Client VPN
	// endpoint.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about the client connection logging options for the Client VPN endpoint.

func (AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) SetCloudwatchLogGroup added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) SetCloudwatchLogGroup(v string) *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails

SetCloudwatchLogGroup sets the CloudwatchLogGroup field's value.

func (*AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) SetCloudwatchLogStream added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) SetCloudwatchLogStream(v string) *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails

SetCloudwatchLogStream sets the CloudwatchLogStream field's value.

func (*AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) SetEnabled added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) SetEnabled(v bool) *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails

SetEnabled sets the Enabled field's value.

func (AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) String() string

String returns the string representation.

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

type AwsEc2ClientVpnEndpointDetails added in v1.49.0 

type AwsEc2ClientVpnEndpointDetails struct {

	// Information about the authentication method used by the Client VPN endpoint.
	AuthenticationOptions []*AwsEc2ClientVpnEndpointAuthenticationOptionsDetails `type:"list"`

	// The IPv4 address range, in CIDR notation, from which client IP addresses
	// are assigned.
	ClientCidrBlock *string `type:"string"`

	// The options for managing connection authorization for new client connections.
	ClientConnectOptions *AwsEc2ClientVpnEndpointClientConnectOptionsDetails `type:"structure"`

	// Options for enabling a customizable text banner that will be displayed on
	// Amazon Web Services provided clients when a VPN session is established.
	ClientLoginBannerOptions *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails `type:"structure"`

	// The ID of the Client VPN endpoint.
	ClientVpnEndpointId *string `type:"string"`

	// Information about the client connection logging options for the Client VPN
	// endpoint.
	ConnectionLogOptions *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails `type:"structure"`

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

	// Information about the DNS servers to be used for DNS resolution.
	DnsServer []*string `type:"list"`

	// The IDs of the security groups for the target network.
	SecurityGroupIdSet []*string `type:"list"`

	// The URL of the self-service portal.
	SelfServicePortalUrl *string `type:"string"`

	// The Amazon Resource Name (ARN) of the server certificate.
	ServerCertificateArn *string `type:"string"`

	// The maximum VPN session duration time in hours.
	SessionTimeoutHours *int64 `type:"integer"`

	// Indicates whether split-tunnel is enabled in the Client VPN endpoint.
	SplitTunnel *bool `type:"boolean"`

	// The transport protocol used by the Client VPN endpoint.
	TransportProtocol *string `type:"string"`

	// The ID of the VPC.
	VpcId *string `type:"string"`

	// The port number for the Client VPN endpoint.
	VpnPort *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.

func (AwsEc2ClientVpnEndpointDetails) GoString added in v1.49.0 

func (s AwsEc2ClientVpnEndpointDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEc2ClientVpnEndpointDetails) SetAuthenticationOptions added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetAuthenticationOptions(v []*AwsEc2ClientVpnEndpointAuthenticationOptionsDetails) *AwsEc2ClientVpnEndpointDetails

SetAuthenticationOptions sets the AuthenticationOptions field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetClientCidrBlock added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetClientCidrBlock(v string) *AwsEc2ClientVpnEndpointDetails

SetClientCidrBlock sets the ClientCidrBlock field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetClientConnectOptions added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetClientConnectOptions(v *AwsEc2ClientVpnEndpointClientConnectOptionsDetails) *AwsEc2ClientVpnEndpointDetails

SetClientConnectOptions sets the ClientConnectOptions field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetClientLoginBannerOptions added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetClientLoginBannerOptions(v *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails) *AwsEc2ClientVpnEndpointDetails

SetClientLoginBannerOptions sets the ClientLoginBannerOptions field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetClientVpnEndpointId added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetClientVpnEndpointId(v string) *AwsEc2ClientVpnEndpointDetails

SetClientVpnEndpointId sets the ClientVpnEndpointId field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetConnectionLogOptions added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetConnectionLogOptions(v *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails) *AwsEc2ClientVpnEndpointDetails

SetConnectionLogOptions sets the ConnectionLogOptions field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetDescription added in v1.49.0 

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

SetDescription sets the Description field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetDnsServer added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetDnsServer(v []*string) *AwsEc2ClientVpnEndpointDetails

SetDnsServer sets the DnsServer field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetSecurityGroupIdSet added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetSecurityGroupIdSet(v []*string) *AwsEc2ClientVpnEndpointDetails

SetSecurityGroupIdSet sets the SecurityGroupIdSet field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetSelfServicePortalUrl added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetSelfServicePortalUrl(v string) *AwsEc2ClientVpnEndpointDetails

SetSelfServicePortalUrl sets the SelfServicePortalUrl field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetServerCertificateArn added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetServerCertificateArn(v string) *AwsEc2ClientVpnEndpointDetails

SetServerCertificateArn sets the ServerCertificateArn field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetSessionTimeoutHours added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetSessionTimeoutHours(v int64) *AwsEc2ClientVpnEndpointDetails

SetSessionTimeoutHours sets the SessionTimeoutHours field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetSplitTunnel added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetSplitTunnel(v bool) *AwsEc2ClientVpnEndpointDetails

SetSplitTunnel sets the SplitTunnel field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetTransportProtocol added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetTransportProtocol(v string) *AwsEc2ClientVpnEndpointDetails

SetTransportProtocol sets the TransportProtocol field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetVpcId added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetVpcId(v string) *AwsEc2ClientVpnEndpointDetails

SetVpcId sets the VpcId field's value.

func (*AwsEc2ClientVpnEndpointDetails) SetVpnPort added in v1.49.0 

func (s *AwsEc2ClientVpnEndpointDetails) SetVpnPort(v int64) *AwsEc2ClientVpnEndpointDetails

SetVpnPort sets the VpnPort field's value.

func (AwsEc2ClientVpnEndpointDetails) String added in v1.49.0 

func (s AwsEc2ClientVpnEndpointDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsEc2EipDetails) SetAllocationId(v string) *AwsEc2EipDetails

SetAllocationId sets the AllocationId field's value.

func (*AwsEc2EipDetails) SetAssociationId added in v1.34.7 

func (s *AwsEc2EipDetails) SetAssociationId(v string) *AwsEc2EipDetails

SetAssociationId sets the AssociationId field's value.

func (*AwsEc2EipDetails) SetDomain added in v1.34.7 

func (s *AwsEc2EipDetails) SetDomain(v string) *AwsEc2EipDetails

SetDomain sets the Domain field's value.

func (*AwsEc2EipDetails) SetInstanceId added in v1.34.7 

func (s *AwsEc2EipDetails) SetInstanceId(v string) *AwsEc2EipDetails

SetInstanceId sets the InstanceId field's value.

func (*AwsEc2EipDetails) SetNetworkBorderGroup added in v1.34.7 

func (s *AwsEc2EipDetails) SetNetworkBorderGroup(v string) *AwsEc2EipDetails

SetNetworkBorderGroup sets the NetworkBorderGroup field's value.

func (*AwsEc2EipDetails) SetNetworkInterfaceId added in v1.34.7 

func (s *AwsEc2EipDetails) SetNetworkInterfaceId(v string) *AwsEc2EipDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsEc2EipDetails) SetNetworkInterfaceOwnerId added in v1.34.7 

func (s *AwsEc2EipDetails) SetNetworkInterfaceOwnerId(v string) *AwsEc2EipDetails

SetNetworkInterfaceOwnerId sets the NetworkInterfaceOwnerId field's value.

func (*AwsEc2EipDetails) SetPrivateIpAddress added in v1.34.7 

func (s *AwsEc2EipDetails) SetPrivateIpAddress(v string) *AwsEc2EipDetails

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*AwsEc2EipDetails) SetPublicIp added in v1.34.7 

func (s *AwsEc2EipDetails) SetPublicIp(v string) *AwsEc2EipDetails

SetPublicIp sets the PublicIp field's value.

func (*AwsEc2EipDetails) SetPublicIpv4Pool added in v1.34.7 

func (s *AwsEc2EipDetails) SetPublicIpv4Pool(v string) *AwsEc2EipDetails

SetPublicIpv4Pool sets the PublicIpv4Pool field's value.

func (AwsEc2EipDetails) String added in v1.34.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 

func (s *AwsEc2InstanceDetails) SetImageId(v string) *AwsEc2InstanceDetails

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 

func (s *AwsEc2InstanceDetails) SetKeyName(v string) *AwsEc2InstanceDetails

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.44.36 

func (s *AwsEc2InstanceDetails) SetMetadataOptions(v *AwsEc2InstanceMetadataOptions) *AwsEc2InstanceDetails

SetMetadataOptions sets the MetadataOptions field's value.

func (*AwsEc2InstanceDetails) SetMonitoring added in v1.44.230 

func (s *AwsEc2InstanceDetails) SetMonitoring(v *AwsEc2InstanceMonitoringDetails) *AwsEc2InstanceDetails

SetMonitoring sets the Monitoring field's value.

func (*AwsEc2InstanceDetails) SetNetworkInterfaces added in v1.38.67 

func (s *AwsEc2InstanceDetails) SetNetworkInterfaces(v []*AwsEc2InstanceNetworkInterfacesDetails) *AwsEc2InstanceDetails

SetNetworkInterfaces sets the NetworkInterfaces field's value.

func (*AwsEc2InstanceDetails) SetSubnetId 

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

SetSubnetId sets the SubnetId field's value.

func (*AwsEc2InstanceDetails) SetType 

func (s *AwsEc2InstanceDetails) SetType(v string) *AwsEc2InstanceDetails

SetType sets the Type field's value.

func (*AwsEc2InstanceDetails) SetVirtualizationType added in v1.44.36 

func (s *AwsEc2InstanceDetails) SetVirtualizationType(v string) *AwsEc2InstanceDetails

SetVirtualizationType sets the VirtualizationType field's value.

func (*AwsEc2InstanceDetails) SetVpcId 

func (s *AwsEc2InstanceDetails) SetVpcId(v string) *AwsEc2InstanceDetails

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.44.36 

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.44.36 

func (s AwsEc2InstanceMetadataOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEc2InstanceMetadataOptions) SetHttpEndpoint(v string) *AwsEc2InstanceMetadataOptions

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*AwsEc2InstanceMetadataOptions) SetHttpProtocolIpv6 added in v1.44.36 

func (s *AwsEc2InstanceMetadataOptions) SetHttpProtocolIpv6(v string) *AwsEc2InstanceMetadataOptions

SetHttpProtocolIpv6 sets the HttpProtocolIpv6 field's value.

func (*AwsEc2InstanceMetadataOptions) SetHttpPutResponseHopLimit added in v1.44.36 

func (s *AwsEc2InstanceMetadataOptions) SetHttpPutResponseHopLimit(v int64) *AwsEc2InstanceMetadataOptions

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*AwsEc2InstanceMetadataOptions) SetHttpTokens added in v1.44.36 

func (s *AwsEc2InstanceMetadataOptions) SetHttpTokens(v string) *AwsEc2InstanceMetadataOptions

SetHttpTokens sets the HttpTokens field's value.

func (*AwsEc2InstanceMetadataOptions) SetInstanceMetadataTags added in v1.44.36 

func (s *AwsEc2InstanceMetadataOptions) SetInstanceMetadataTags(v string) *AwsEc2InstanceMetadataOptions

SetInstanceMetadataTags sets the InstanceMetadataTags field's value.

func (AwsEc2InstanceMetadataOptions) String added in v1.44.36 

func (s AwsEc2InstanceMetadataOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

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.44.230 

func (s AwsEc2InstanceMonitoringDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

func (s *AwsEc2InstanceMonitoringDetails) SetState(v string) *AwsEc2InstanceMonitoringDetails

SetState sets the State field's value.

func (AwsEc2InstanceMonitoringDetails) String added in v1.44.230 

func (s AwsEc2InstanceMonitoringDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEc2InstanceNetworkInterfacesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEc2InstanceNetworkInterfacesDetails) SetNetworkInterfaceId(v string) *AwsEc2InstanceNetworkInterfacesDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (AwsEc2InstanceNetworkInterfacesDetails) String added in v1.38.67 

func (s AwsEc2InstanceNetworkInterfacesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetDeviceName(v string) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails

SetDeviceName sets the DeviceName field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetEbs added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetEbs(v *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails

SetEbs sets the Ebs field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetNoDevice added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetNoDevice(v string) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails

SetNoDevice sets the NoDevice field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetVirtualName added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetVirtualName(v string) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails

SetVirtualName sets the VirtualName field's value.

func (AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetDeleteOnTermination(v bool) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetEncrypted added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetEncrypted(v bool) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetEncrypted sets the Encrypted field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetIops added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetIops(v int64) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetIops sets the Iops field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetKmsKeyId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetKmsKeyId(v string) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetSnapshotId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetSnapshotId(v string) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetSnapshotId sets the SnapshotId field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetThroughput added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetThroughput(v int64) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetThroughput sets the Throughput field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetVolumeSize added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetVolumeSize(v int64) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetVolumeSize sets the VolumeSize field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetVolumeType added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetVolumeType(v string) *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails

SetVolumeType sets the VolumeType field's value.

func (AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) SetCapacityReservationId(v string) *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails

SetCapacityReservationId sets the CapacityReservationId field's value.

func (*AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) SetCapacityReservationResourceGroupArn added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) SetCapacityReservationResourceGroupArn(v string) *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails

SetCapacityReservationResourceGroupArn sets the CapacityReservationResourceGroupArn field's value.

func (AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) SetCapacityReservationPreference(v string) *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails

SetCapacityReservationPreference sets the CapacityReservationPreference field's value.

func (*AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) SetCapacityReservationTarget added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) SetCapacityReservationTarget(v *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails

SetCapacityReservationTarget sets the CapacityReservationTarget field's value.

func (AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataCpuOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataCpuOptionsDetails) SetCoreCount(v int64) *AwsEc2LaunchTemplateDataCpuOptionsDetails

SetCoreCount sets the CoreCount field's value.

func (*AwsEc2LaunchTemplateDataCpuOptionsDetails) SetThreadsPerCore added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataCpuOptionsDetails) SetThreadsPerCore(v int64) *AwsEc2LaunchTemplateDataCpuOptionsDetails

SetThreadsPerCore sets the ThreadsPerCore field's value.

func (AwsEc2LaunchTemplateDataCpuOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataCpuOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataCreditSpecificationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataCreditSpecificationDetails) SetCpuCredits(v string) *AwsEc2LaunchTemplateDataCreditSpecificationDetails

SetCpuCredits sets the CpuCredits field's value.

func (AwsEc2LaunchTemplateDataCreditSpecificationDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataCreditSpecificationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetBlockDeviceMappingSet(v []*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) *AwsEc2LaunchTemplateDataDetails

SetBlockDeviceMappingSet sets the BlockDeviceMappingSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetCapacityReservationSpecification added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetCapacityReservationSpecification(v *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) *AwsEc2LaunchTemplateDataDetails

SetCapacityReservationSpecification sets the CapacityReservationSpecification field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetCpuOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetCpuOptions(v *AwsEc2LaunchTemplateDataCpuOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetCpuOptions sets the CpuOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetCreditSpecification added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetCreditSpecification(v *AwsEc2LaunchTemplateDataCreditSpecificationDetails) *AwsEc2LaunchTemplateDataDetails

SetCreditSpecification sets the CreditSpecification field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetDisableApiStop added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetDisableApiStop(v bool) *AwsEc2LaunchTemplateDataDetails

SetDisableApiStop sets the DisableApiStop field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetDisableApiTermination added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetDisableApiTermination(v bool) *AwsEc2LaunchTemplateDataDetails

SetDisableApiTermination sets the DisableApiTermination field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetEbsOptimized added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetEbsOptimized(v bool) *AwsEc2LaunchTemplateDataDetails

SetEbsOptimized sets the EbsOptimized field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetElasticGpuSpecificationSet added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetElasticGpuSpecificationSet(v []*AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) *AwsEc2LaunchTemplateDataDetails

SetElasticGpuSpecificationSet sets the ElasticGpuSpecificationSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetElasticInferenceAcceleratorSet added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetElasticInferenceAcceleratorSet(v []*AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) *AwsEc2LaunchTemplateDataDetails

SetElasticInferenceAcceleratorSet sets the ElasticInferenceAcceleratorSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetEnclaveOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetEnclaveOptions(v *AwsEc2LaunchTemplateDataEnclaveOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetEnclaveOptions sets the EnclaveOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetHibernationOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetHibernationOptions(v *AwsEc2LaunchTemplateDataHibernationOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetHibernationOptions sets the HibernationOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetIamInstanceProfile added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetIamInstanceProfile(v *AwsEc2LaunchTemplateDataIamInstanceProfileDetails) *AwsEc2LaunchTemplateDataDetails

SetIamInstanceProfile sets the IamInstanceProfile field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetImageId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetImageId(v string) *AwsEc2LaunchTemplateDataDetails

SetImageId sets the ImageId field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceInitiatedShutdownBehavior added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetInstanceInitiatedShutdownBehavior(v string) *AwsEc2LaunchTemplateDataDetails

SetInstanceInitiatedShutdownBehavior sets the InstanceInitiatedShutdownBehavior field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceMarketOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetInstanceMarketOptions(v *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetInstanceMarketOptions sets the InstanceMarketOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceRequirements added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetInstanceRequirements(v *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) *AwsEc2LaunchTemplateDataDetails

SetInstanceRequirements sets the InstanceRequirements field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceType added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetInstanceType(v string) *AwsEc2LaunchTemplateDataDetails

SetInstanceType sets the InstanceType field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetKernelId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetKernelId(v string) *AwsEc2LaunchTemplateDataDetails

SetKernelId sets the KernelId field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetKeyName added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetKeyName(v string) *AwsEc2LaunchTemplateDataDetails

SetKeyName sets the KeyName field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetLicenseSet added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetLicenseSet(v []*AwsEc2LaunchTemplateDataLicenseSetDetails) *AwsEc2LaunchTemplateDataDetails

SetLicenseSet sets the LicenseSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetMaintenanceOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetMaintenanceOptions(v *AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetMaintenanceOptions sets the MaintenanceOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetMetadataOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetMetadataOptions(v *AwsEc2LaunchTemplateDataMetadataOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetMetadataOptions sets the MetadataOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetMonitoring added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetMonitoring(v *AwsEc2LaunchTemplateDataMonitoringDetails) *AwsEc2LaunchTemplateDataDetails

SetMonitoring sets the Monitoring field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetNetworkInterfaceSet added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetNetworkInterfaceSet(v []*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) *AwsEc2LaunchTemplateDataDetails

SetNetworkInterfaceSet sets the NetworkInterfaceSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetPlacement added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetPlacement(v *AwsEc2LaunchTemplateDataPlacementDetails) *AwsEc2LaunchTemplateDataDetails

SetPlacement sets the Placement field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetPrivateDnsNameOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetPrivateDnsNameOptions(v *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) *AwsEc2LaunchTemplateDataDetails

SetPrivateDnsNameOptions sets the PrivateDnsNameOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetRamDiskId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetRamDiskId(v string) *AwsEc2LaunchTemplateDataDetails

SetRamDiskId sets the RamDiskId field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetSecurityGroupIdSet added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetSecurityGroupIdSet(v []*string) *AwsEc2LaunchTemplateDataDetails

SetSecurityGroupIdSet sets the SecurityGroupIdSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetSecurityGroupSet added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetSecurityGroupSet(v []*string) *AwsEc2LaunchTemplateDataDetails

SetSecurityGroupSet sets the SecurityGroupSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetUserData added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataDetails) SetUserData(v string) *AwsEc2LaunchTemplateDataDetails

SetUserData sets the UserData field's value.

func (AwsEc2LaunchTemplateDataDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) SetType(v string) *AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails

SetType sets the Type field's value.

func (AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) SetCount(v int64) *AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails

SetCount sets the Count field's value.

func (*AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) SetType added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) SetType(v string) *AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails

SetType sets the Type field's value.

func (AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataEnclaveOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataEnclaveOptionsDetails) SetEnabled(v bool) *AwsEc2LaunchTemplateDataEnclaveOptionsDetails

SetEnabled sets the Enabled field's value.

func (AwsEc2LaunchTemplateDataEnclaveOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataEnclaveOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataHibernationOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataHibernationOptionsDetails) SetConfigured(v bool) *AwsEc2LaunchTemplateDataHibernationOptionsDetails

SetConfigured sets the Configured field's value.

func (AwsEc2LaunchTemplateDataHibernationOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataHibernationOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataIamInstanceProfileDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataIamInstanceProfileDetails) SetArn(v string) *AwsEc2LaunchTemplateDataIamInstanceProfileDetails

SetArn sets the Arn field's value.

func (*AwsEc2LaunchTemplateDataIamInstanceProfileDetails) SetName added in v1.44.161 

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

SetName sets the Name field's value.

func (AwsEc2LaunchTemplateDataIamInstanceProfileDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataIamInstanceProfileDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) SetMarketType(v string) *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails

SetMarketType sets the MarketType field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) SetSpotOptions added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) SetSpotOptions(v *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails

SetSpotOptions sets the SpotOptions field's value.

func (AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetBlockDurationMinutes(v int64) *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails

SetBlockDurationMinutes sets the BlockDurationMinutes field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetInstanceInterruptionBehavior added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetInstanceInterruptionBehavior(v string) *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails

SetInstanceInterruptionBehavior sets the InstanceInterruptionBehavior field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetMaxPrice added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetMaxPrice(v string) *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails

SetMaxPrice sets the MaxPrice field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetSpotInstanceType added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetSpotInstanceType(v string) *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails

SetSpotInstanceType sets the SpotInstanceType field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetValidUntil added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetValidUntil(v string) *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails

SetValidUntil sets the ValidUntil field's value.

func (AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) SetMax(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) SetMin(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) SetMax(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) SetMin(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) SetMax(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) SetMin(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorCount(v *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetAcceleratorCount sets the AcceleratorCount field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorManufacturers added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorManufacturers(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetAcceleratorManufacturers sets the AcceleratorManufacturers field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorNames added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorNames(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetAcceleratorNames sets the AcceleratorNames field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorTotalMemoryMiB added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorTotalMemoryMiB(v *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetAcceleratorTotalMemoryMiB sets the AcceleratorTotalMemoryMiB field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorTypes added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorTypes(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBareMetal added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBareMetal(v string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetBareMetal sets the BareMetal field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBaselineEbsBandwidthMbps added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBaselineEbsBandwidthMbps(v *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetBaselineEbsBandwidthMbps sets the BaselineEbsBandwidthMbps field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBurstablePerformance added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBurstablePerformance(v string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetBurstablePerformance sets the BurstablePerformance field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetCpuManufacturers added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetCpuManufacturers(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetCpuManufacturers sets the CpuManufacturers field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetExcludedInstanceTypes added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetExcludedInstanceTypes(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetExcludedInstanceTypes sets the ExcludedInstanceTypes field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetInstanceGenerations added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetInstanceGenerations(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetInstanceGenerations sets the InstanceGenerations field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetLocalStorage added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetLocalStorage(v string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetLocalStorage sets the LocalStorage field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetLocalStorageTypes added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetLocalStorageTypes(v []*string) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetLocalStorageTypes sets the LocalStorageTypes field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetMemoryGiBPerVCpu added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetMemoryGiBPerVCpu(v *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetMemoryGiBPerVCpu sets the MemoryGiBPerVCpu field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetMemoryMiB added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetMemoryMiB(v *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetMemoryMiB sets the MemoryMiB field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetNetworkInterfaceCount added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetNetworkInterfaceCount(v *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetNetworkInterfaceCount sets the NetworkInterfaceCount field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetOnDemandMaxPricePercentageOverLowestPrice added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetOnDemandMaxPricePercentageOverLowestPrice(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetOnDemandMaxPricePercentageOverLowestPrice sets the OnDemandMaxPricePercentageOverLowestPrice field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetRequireHibernateSupport added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetRequireHibernateSupport(v bool) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetRequireHibernateSupport sets the RequireHibernateSupport field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetSpotMaxPricePercentageOverLowestPrice added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetSpotMaxPricePercentageOverLowestPrice(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetSpotMaxPricePercentageOverLowestPrice sets the SpotMaxPricePercentageOverLowestPrice field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetTotalLocalStorageGB added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetTotalLocalStorageGB(v *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetTotalLocalStorageGB sets the TotalLocalStorageGB field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetVCpuCount added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetVCpuCount(v *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) *AwsEc2LaunchTemplateDataInstanceRequirementsDetails

SetVCpuCount sets the VCpuCount field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) SetMax(v float64) *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) SetMin(v float64) *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) SetMax(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) SetMin(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) SetMax(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) SetMin(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) SetMax(v float64) *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) SetMin(v float64) *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) SetMax(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) SetMin added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) SetMin(v int64) *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataLicenseSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataLicenseSetDetails) SetLicenseConfigurationArn(v string) *AwsEc2LaunchTemplateDataLicenseSetDetails

SetLicenseConfigurationArn sets the LicenseConfigurationArn field's value.

func (AwsEc2LaunchTemplateDataLicenseSetDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataLicenseSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) SetAutoRecovery(v string) *AwsEc2LaunchTemplateDataMaintenanceOptionsDetails

SetAutoRecovery sets the AutoRecovery field's value.

func (AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataMetadataOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpEndpoint(v string) *AwsEc2LaunchTemplateDataMetadataOptionsDetails

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpProtocolIpv6 added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpProtocolIpv6(v string) *AwsEc2LaunchTemplateDataMetadataOptionsDetails

SetHttpProtocolIpv6 sets the HttpProtocolIpv6 field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpPutResponseHopLimit added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpPutResponseHopLimit(v int64) *AwsEc2LaunchTemplateDataMetadataOptionsDetails

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpTokens added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpTokens(v string) *AwsEc2LaunchTemplateDataMetadataOptionsDetails

SetHttpTokens sets the HttpTokens field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetInstanceMetadataTags added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetInstanceMetadataTags(v string) *AwsEc2LaunchTemplateDataMetadataOptionsDetails

SetInstanceMetadataTags sets the InstanceMetadataTags field's value.

func (AwsEc2LaunchTemplateDataMetadataOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataMetadataOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataMonitoringDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataMonitoringDetails) SetEnabled(v bool) *AwsEc2LaunchTemplateDataMonitoringDetails

SetEnabled sets the Enabled field's value.

func (AwsEc2LaunchTemplateDataMonitoringDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataMonitoringDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetAssociateCarrierIpAddress(v bool) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetAssociateCarrierIpAddress sets the AssociateCarrierIpAddress field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetAssociatePublicIpAddress added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetAssociatePublicIpAddress(v bool) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDeleteOnTermination added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDeleteOnTermination(v bool) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDescription added in v1.44.161 

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

SetDescription sets the Description field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDeviceIndex added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDeviceIndex(v int64) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetDeviceIndex sets the DeviceIndex field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetGroups added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetGroups(v []*string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetGroups sets the Groups field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetInterfaceType added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetInterfaceType(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetInterfaceType sets the InterfaceType field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv4PrefixCount added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv4PrefixCount(v int64) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetIpv4PrefixCount sets the Ipv4PrefixCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv4Prefixes added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv4Prefixes(v []*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetIpv4Prefixes sets the Ipv4Prefixes field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6AddressCount added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6AddressCount(v int64) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetIpv6AddressCount sets the Ipv6AddressCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6Addresses added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6Addresses(v []*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetIpv6Addresses sets the Ipv6Addresses field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6PrefixCount added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6PrefixCount(v int64) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetIpv6PrefixCount sets the Ipv6PrefixCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6Prefixes added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6Prefixes(v []*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetIpv6Prefixes sets the Ipv6Prefixes field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetNetworkCardIndex added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetNetworkCardIndex(v int64) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetNetworkCardIndex sets the NetworkCardIndex field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetNetworkInterfaceId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetNetworkInterfaceId(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetPrivateIpAddress added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetPrivateIpAddress(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetPrivateIpAddresses added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetPrivateIpAddresses(v []*AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetPrivateIpAddresses sets the PrivateIpAddresses field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetSecondaryPrivateIpAddressCount added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetSecondaryPrivateIpAddressCount(v int64) *AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails

SetSecondaryPrivateIpAddressCount sets the SecondaryPrivateIpAddressCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetSubnetId added in v1.44.161 

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

SetSubnetId sets the SubnetId field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) SetIpv4Prefix(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails

SetIpv4Prefix sets the Ipv4Prefix field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) SetIpv6Address(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails

SetIpv6Address sets the Ipv6Address field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) SetIpv6Prefix(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails

SetIpv6Prefix sets the Ipv6Prefix field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) SetPrimary(v bool) *AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails

SetPrimary sets the Primary field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) SetPrivateIpAddress added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) SetPrivateIpAddress(v string) *AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataPlacementDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetAffinity(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetAffinity sets the Affinity field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetAvailabilityZone added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetAvailabilityZone(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetGroupName added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetGroupName(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetGroupName sets the GroupName field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetHostId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetHostId(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetHostId sets the HostId field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetHostResourceGroupArn added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetHostResourceGroupArn(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetHostResourceGroupArn sets the HostResourceGroupArn field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetPartitionNumber added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetPartitionNumber(v int64) *AwsEc2LaunchTemplateDataPlacementDetails

SetPartitionNumber sets the PartitionNumber field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetSpreadDomain added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetSpreadDomain(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetSpreadDomain sets the SpreadDomain field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetTenancy added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPlacementDetails) SetTenancy(v string) *AwsEc2LaunchTemplateDataPlacementDetails

SetTenancy sets the Tenancy field's value.

func (AwsEc2LaunchTemplateDataPlacementDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataPlacementDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetEnableResourceNameDnsAAAARecord(v bool) *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails

SetEnableResourceNameDnsAAAARecord sets the EnableResourceNameDnsAAAARecord field's value.

func (*AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetEnableResourceNameDnsARecord added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetEnableResourceNameDnsARecord(v bool) *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails

SetEnableResourceNameDnsARecord sets the EnableResourceNameDnsARecord field's value.

func (*AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetHostnameType added in v1.44.161 

func (s *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetHostnameType(v string) *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails

SetHostnameType sets the HostnameType field's value.

func (AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsEc2LaunchTemplateDetails) SetDefaultVersionNumber(v int64) *AwsEc2LaunchTemplateDetails

SetDefaultVersionNumber sets the DefaultVersionNumber field's value.

func (*AwsEc2LaunchTemplateDetails) SetId added in v1.44.161 

func (s *AwsEc2LaunchTemplateDetails) SetId(v string) *AwsEc2LaunchTemplateDetails

SetId sets the Id field's value.

func (*AwsEc2LaunchTemplateDetails) SetLatestVersionNumber added in v1.44.161 

func (s *AwsEc2LaunchTemplateDetails) SetLatestVersionNumber(v int64) *AwsEc2LaunchTemplateDetails

SetLatestVersionNumber sets the LatestVersionNumber field's value.

func (*AwsEc2LaunchTemplateDetails) SetLaunchTemplateData added in v1.44.161 

func (s *AwsEc2LaunchTemplateDetails) SetLaunchTemplateData(v *AwsEc2LaunchTemplateDataDetails) *AwsEc2LaunchTemplateDetails

SetLaunchTemplateData sets the LaunchTemplateData field's value.

func (*AwsEc2LaunchTemplateDetails) SetLaunchTemplateName added in v1.44.161 

func (s *AwsEc2LaunchTemplateDetails) SetLaunchTemplateName(v string) *AwsEc2LaunchTemplateDetails

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (AwsEc2LaunchTemplateDetails) String added in v1.44.161 

func (s AwsEc2LaunchTemplateDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

func (s *AwsEc2NetworkAclAssociation) SetNetworkAclAssociationId(v string) *AwsEc2NetworkAclAssociation

SetNetworkAclAssociationId sets the NetworkAclAssociationId field's value.

func (*AwsEc2NetworkAclAssociation) SetNetworkAclId added in v1.38.31 

func (s *AwsEc2NetworkAclAssociation) SetNetworkAclId(v string) *AwsEc2NetworkAclAssociation

SetNetworkAclId sets the NetworkAclId field's value.

func (*AwsEc2NetworkAclAssociation) SetSubnetId added in v1.38.31 

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

SetSubnetId sets the SubnetId field's value.

func (AwsEc2NetworkAclAssociation) String added in v1.38.31 

func (s AwsEc2NetworkAclAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

func (s *AwsEc2NetworkAclDetails) SetAssociations(v []*AwsEc2NetworkAclAssociation) *AwsEc2NetworkAclDetails

SetAssociations sets the Associations field's value.

func (*AwsEc2NetworkAclDetails) SetEntries added in v1.38.31 

func (s *AwsEc2NetworkAclDetails) SetEntries(v []*AwsEc2NetworkAclEntry) *AwsEc2NetworkAclDetails

SetEntries sets the Entries field's value.

func (*AwsEc2NetworkAclDetails) SetIsDefault added in v1.38.31 

func (s *AwsEc2NetworkAclDetails) SetIsDefault(v bool) *AwsEc2NetworkAclDetails

SetIsDefault sets the IsDefault field's value.

func (*AwsEc2NetworkAclDetails) SetNetworkAclId added in v1.38.31 

func (s *AwsEc2NetworkAclDetails) SetNetworkAclId(v string) *AwsEc2NetworkAclDetails

SetNetworkAclId sets the NetworkAclId field's value.

func (*AwsEc2NetworkAclDetails) SetOwnerId added in v1.38.31 

func (s *AwsEc2NetworkAclDetails) SetOwnerId(v string) *AwsEc2NetworkAclDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2NetworkAclDetails) SetVpcId added in v1.38.31 

func (s *AwsEc2NetworkAclDetails) SetVpcId(v string) *AwsEc2NetworkAclDetails

SetVpcId sets the VpcId field's value.

func (AwsEc2NetworkAclDetails) String added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetCidrBlock(v string) *AwsEc2NetworkAclEntry

SetCidrBlock sets the CidrBlock field's value.

func (*AwsEc2NetworkAclEntry) SetEgress added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetEgress(v bool) *AwsEc2NetworkAclEntry

SetEgress sets the Egress field's value.

func (*AwsEc2NetworkAclEntry) SetIcmpTypeCode added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetIcmpTypeCode(v *IcmpTypeCode) *AwsEc2NetworkAclEntry

SetIcmpTypeCode sets the IcmpTypeCode field's value.

func (*AwsEc2NetworkAclEntry) SetIpv6CidrBlock added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetIpv6CidrBlock(v string) *AwsEc2NetworkAclEntry

SetIpv6CidrBlock sets the Ipv6CidrBlock field's value.

func (*AwsEc2NetworkAclEntry) SetPortRange added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetPortRange(v *PortRangeFromTo) *AwsEc2NetworkAclEntry

SetPortRange sets the PortRange field's value.

func (*AwsEc2NetworkAclEntry) SetProtocol added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetProtocol(v string) *AwsEc2NetworkAclEntry

SetProtocol sets the Protocol field's value.

func (*AwsEc2NetworkAclEntry) SetRuleAction added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetRuleAction(v string) *AwsEc2NetworkAclEntry

SetRuleAction sets the RuleAction field's value.

func (*AwsEc2NetworkAclEntry) SetRuleNumber added in v1.38.31 

func (s *AwsEc2NetworkAclEntry) SetRuleNumber(v int64) *AwsEc2NetworkAclEntry

SetRuleNumber sets the RuleNumber field's value.

func (AwsEc2NetworkAclEntry) String added in v1.38.31 

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 added in v1.28.11 

type AwsEc2NetworkInterfaceAttachment struct {

	// Indicates when the attachment initiated.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.28.11 

func (s AwsEc2NetworkInterfaceAttachment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsEc2NetworkInterfaceAttachment) SetAttachTime(v string) *AwsEc2NetworkInterfaceAttachment

SetAttachTime sets the AttachTime field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetAttachmentId added in v1.28.11 

func (s *AwsEc2NetworkInterfaceAttachment) SetAttachmentId(v string) *AwsEc2NetworkInterfaceAttachment

SetAttachmentId sets the AttachmentId field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetDeleteOnTermination added in v1.28.11 

func (s *AwsEc2NetworkInterfaceAttachment) SetDeleteOnTermination(v bool) *AwsEc2NetworkInterfaceAttachment

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetDeviceIndex added in v1.28.11 

func (s *AwsEc2NetworkInterfaceAttachment) SetDeviceIndex(v int64) *AwsEc2NetworkInterfaceAttachment

SetDeviceIndex sets the DeviceIndex field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetInstanceId added in v1.28.11 

func (s *AwsEc2NetworkInterfaceAttachment) SetInstanceId(v string) *AwsEc2NetworkInterfaceAttachment

SetInstanceId sets the InstanceId field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetInstanceOwnerId added in v1.28.11 

func (s *AwsEc2NetworkInterfaceAttachment) SetInstanceOwnerId(v string) *AwsEc2NetworkInterfaceAttachment

SetInstanceOwnerId sets the InstanceOwnerId field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetStatus added in v1.28.11 

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

SetStatus sets the Status field's value.

func (AwsEc2NetworkInterfaceAttachment) String added in v1.28.11 

func (s AwsEc2NetworkInterfaceAttachment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsEc2NetworkInterfaceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsEc2NetworkInterfaceDetails) SetAttachment(v *AwsEc2NetworkInterfaceAttachment) *AwsEc2NetworkInterfaceDetails

SetAttachment sets the Attachment field's value.

func (*AwsEc2NetworkInterfaceDetails) SetIpV6Addresses added in v1.36.30 

func (s *AwsEc2NetworkInterfaceDetails) SetIpV6Addresses(v []*AwsEc2NetworkInterfaceIpV6AddressDetail) *AwsEc2NetworkInterfaceDetails

SetIpV6Addresses sets the IpV6Addresses field's value.

func (*AwsEc2NetworkInterfaceDetails) SetNetworkInterfaceId added in v1.28.11 

func (s *AwsEc2NetworkInterfaceDetails) SetNetworkInterfaceId(v string) *AwsEc2NetworkInterfaceDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsEc2NetworkInterfaceDetails) SetPrivateIpAddresses added in v1.36.30 

func (s *AwsEc2NetworkInterfaceDetails) SetPrivateIpAddresses(v []*AwsEc2NetworkInterfacePrivateIpAddressDetail) *AwsEc2NetworkInterfaceDetails

SetPrivateIpAddresses sets the PrivateIpAddresses field's value.

func (*AwsEc2NetworkInterfaceDetails) SetPublicDnsName added in v1.36.30 

func (s *AwsEc2NetworkInterfaceDetails) SetPublicDnsName(v string) *AwsEc2NetworkInterfaceDetails

SetPublicDnsName sets the PublicDnsName field's value.

func (*AwsEc2NetworkInterfaceDetails) SetPublicIp added in v1.36.30 

func (s *AwsEc2NetworkInterfaceDetails) SetPublicIp(v string) *AwsEc2NetworkInterfaceDetails

SetPublicIp sets the PublicIp field's value.

func (*AwsEc2NetworkInterfaceDetails) SetSecurityGroups added in v1.28.11 

func (s *AwsEc2NetworkInterfaceDetails) SetSecurityGroups(v []*AwsEc2NetworkInterfaceSecurityGroup) *AwsEc2NetworkInterfaceDetails

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsEc2NetworkInterfaceDetails) SetSourceDestCheck added in v1.28.11 

func (s *AwsEc2NetworkInterfaceDetails) SetSourceDestCheck(v bool) *AwsEc2NetworkInterfaceDetails

SetSourceDestCheck sets the SourceDestCheck field's value.

func (AwsEc2NetworkInterfaceDetails) String added in v1.28.11 

func (s AwsEc2NetworkInterfaceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

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 added in v1.36.30 

func (s AwsEc2NetworkInterfaceIpV6AddressDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

func (s *AwsEc2NetworkInterfaceIpV6AddressDetail) SetIpV6Address(v string) *AwsEc2NetworkInterfaceIpV6AddressDetail

SetIpV6Address sets the IpV6Address field's value.

func (AwsEc2NetworkInterfaceIpV6AddressDetail) String added in v1.36.30 

func (s AwsEc2NetworkInterfaceIpV6AddressDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

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 added in v1.36.30 

func (s AwsEc2NetworkInterfacePrivateIpAddressDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

func (s *AwsEc2NetworkInterfacePrivateIpAddressDetail) SetPrivateDnsName(v string) *AwsEc2NetworkInterfacePrivateIpAddressDetail

SetPrivateDnsName sets the PrivateDnsName field's value.

func (*AwsEc2NetworkInterfacePrivateIpAddressDetail) SetPrivateIpAddress added in v1.36.30 

func (s *AwsEc2NetworkInterfacePrivateIpAddressDetail) SetPrivateIpAddress(v string) *AwsEc2NetworkInterfacePrivateIpAddressDetail

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (AwsEc2NetworkInterfacePrivateIpAddressDetail) String added in v1.36.30 

func (s AwsEc2NetworkInterfacePrivateIpAddressDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsEc2NetworkInterfaceSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsEc2NetworkInterfaceSecurityGroup) SetGroupId(v string) *AwsEc2NetworkInterfaceSecurityGroup

SetGroupId sets the GroupId field's value.

func (*AwsEc2NetworkInterfaceSecurityGroup) SetGroupName added in v1.28.11 

func (s *AwsEc2NetworkInterfaceSecurityGroup) SetGroupName(v string) *AwsEc2NetworkInterfaceSecurityGroup

SetGroupName sets the GroupName field's value.

func (AwsEc2NetworkInterfaceSecurityGroup) String added in v1.28.11 

func (s AwsEc2NetworkInterfaceSecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

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.44.230 

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.44.230 

func (s *AwsEc2RouteTableDetails) SetAssociationSet(v []*AssociationSetDetails) *AwsEc2RouteTableDetails

SetAssociationSet sets the AssociationSet field's value.

func (*AwsEc2RouteTableDetails) SetOwnerId added in v1.44.230 

func (s *AwsEc2RouteTableDetails) SetOwnerId(v string) *AwsEc2RouteTableDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2RouteTableDetails) SetPropagatingVgwSet added in v1.44.230 

func (s *AwsEc2RouteTableDetails) SetPropagatingVgwSet(v []*PropagatingVgwSetDetails) *AwsEc2RouteTableDetails

SetPropagatingVgwSet sets the PropagatingVgwSet field's value.

func (*AwsEc2RouteTableDetails) SetRouteSet added in v1.44.230 

func (s *AwsEc2RouteTableDetails) SetRouteSet(v []*RouteSetDetails) *AwsEc2RouteTableDetails

SetRouteSet sets the RouteSet field's value.

func (*AwsEc2RouteTableDetails) SetRouteTableId added in v1.44.230 

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

SetRouteTableId sets the RouteTableId field's value.

func (*AwsEc2RouteTableDetails) SetVpcId added in v1.44.230 

func (s *AwsEc2RouteTableDetails) SetVpcId(v string) *AwsEc2RouteTableDetails

SetVpcId sets the VpcId field's value.

func (AwsEc2RouteTableDetails) String added in v1.44.230 

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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsEc2SecurityGroupDetails) SetGroupId(v string) *AwsEc2SecurityGroupDetails

SetGroupId sets the GroupId field's value.

func (*AwsEc2SecurityGroupDetails) SetGroupName added in v1.28.11 

func (s *AwsEc2SecurityGroupDetails) SetGroupName(v string) *AwsEc2SecurityGroupDetails

SetGroupName sets the GroupName field's value.

func (*AwsEc2SecurityGroupDetails) SetIpPermissions added in v1.28.11 

func (s *AwsEc2SecurityGroupDetails) SetIpPermissions(v []*AwsEc2SecurityGroupIpPermission) *AwsEc2SecurityGroupDetails

SetIpPermissions sets the IpPermissions field's value.

func (*AwsEc2SecurityGroupDetails) SetIpPermissionsEgress added in v1.28.11 

func (s *AwsEc2SecurityGroupDetails) SetIpPermissionsEgress(v []*AwsEc2SecurityGroupIpPermission) *AwsEc2SecurityGroupDetails

SetIpPermissionsEgress sets the IpPermissionsEgress field's value.

func (*AwsEc2SecurityGroupDetails) SetOwnerId added in v1.28.11 

func (s *AwsEc2SecurityGroupDetails) SetOwnerId(v string) *AwsEc2SecurityGroupDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2SecurityGroupDetails) SetVpcId added in v1.28.11 

func (s *AwsEc2SecurityGroupDetails) SetVpcId(v string) *AwsEc2SecurityGroupDetails

SetVpcId sets the VpcId field's value.

func (AwsEc2SecurityGroupDetails) String added in v1.28.11 

func (s AwsEc2SecurityGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsEc2SecurityGroupIpPermission) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetFromPort(v int64) *AwsEc2SecurityGroupIpPermission

SetFromPort sets the FromPort field's value.

func (*AwsEc2SecurityGroupIpPermission) SetIpProtocol added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetIpProtocol(v string) *AwsEc2SecurityGroupIpPermission

SetIpProtocol sets the IpProtocol field's value.

func (*AwsEc2SecurityGroupIpPermission) SetIpRanges added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetIpRanges(v []*AwsEc2SecurityGroupIpRange) *AwsEc2SecurityGroupIpPermission

SetIpRanges sets the IpRanges field's value.

func (*AwsEc2SecurityGroupIpPermission) SetIpv6Ranges added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetIpv6Ranges(v []*AwsEc2SecurityGroupIpv6Range) *AwsEc2SecurityGroupIpPermission

SetIpv6Ranges sets the Ipv6Ranges field's value.

func (*AwsEc2SecurityGroupIpPermission) SetPrefixListIds added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetPrefixListIds(v []*AwsEc2SecurityGroupPrefixListId) *AwsEc2SecurityGroupIpPermission

SetPrefixListIds sets the PrefixListIds field's value.

func (*AwsEc2SecurityGroupIpPermission) SetToPort added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetToPort(v int64) *AwsEc2SecurityGroupIpPermission

SetToPort sets the ToPort field's value.

func (*AwsEc2SecurityGroupIpPermission) SetUserIdGroupPairs added in v1.28.11 

func (s *AwsEc2SecurityGroupIpPermission) SetUserIdGroupPairs(v []*AwsEc2SecurityGroupUserIdGroupPair) *AwsEc2SecurityGroupIpPermission

SetUserIdGroupPairs sets the UserIdGroupPairs field's value.

func (AwsEc2SecurityGroupIpPermission) String added in v1.28.11 

func (s AwsEc2SecurityGroupIpPermission) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsEc2SecurityGroupIpRange) SetCidrIp(v string) *AwsEc2SecurityGroupIpRange

SetCidrIp sets the CidrIp field's value.

func (AwsEc2SecurityGroupIpRange) String added in v1.28.11 

func (s AwsEc2SecurityGroupIpRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsEc2SecurityGroupIpv6Range) SetCidrIpv6(v string) *AwsEc2SecurityGroupIpv6Range

SetCidrIpv6 sets the CidrIpv6 field's value.

func (AwsEc2SecurityGroupIpv6Range) String added in v1.28.11 

func (s AwsEc2SecurityGroupIpv6Range) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

type AwsEc2SecurityGroupPrefixListId struct {

	// The ID of the prefix.
	PrefixListId *string `type:"string"`
	// contains filtered or unexported fields
}

A prefix list ID.

func (AwsEc2SecurityGroupPrefixListId) GoString added in v1.28.11 

func (s AwsEc2SecurityGroupPrefixListId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsEc2SecurityGroupPrefixListId) SetPrefixListId(v string) *AwsEc2SecurityGroupPrefixListId

SetPrefixListId sets the PrefixListId field's value.

func (AwsEc2SecurityGroupPrefixListId) String added in v1.28.11 

func (s AwsEc2SecurityGroupPrefixListId) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsEc2SecurityGroupUserIdGroupPair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsEc2SecurityGroupUserIdGroupPair) SetGroupId(v string) *AwsEc2SecurityGroupUserIdGroupPair

SetGroupId sets the GroupId field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetGroupName added in v1.28.11 

func (s *AwsEc2SecurityGroupUserIdGroupPair) SetGroupName(v string) *AwsEc2SecurityGroupUserIdGroupPair

SetGroupName sets the GroupName field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetPeeringStatus added in v1.28.11 

func (s *AwsEc2SecurityGroupUserIdGroupPair) SetPeeringStatus(v string) *AwsEc2SecurityGroupUserIdGroupPair

SetPeeringStatus sets the PeeringStatus field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetUserId added in v1.28.11 

func (s *AwsEc2SecurityGroupUserIdGroupPair) SetUserId(v string) *AwsEc2SecurityGroupUserIdGroupPair

SetUserId sets the UserId field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetVpcId added in v1.28.11 

func (s *AwsEc2SecurityGroupUserIdGroupPair) SetVpcId(v string) *AwsEc2SecurityGroupUserIdGroupPair

SetVpcId sets the VpcId field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetVpcPeeringConnectionId added in v1.28.11 

func (s *AwsEc2SecurityGroupUserIdGroupPair) SetVpcPeeringConnectionId(v string) *AwsEc2SecurityGroupUserIdGroupPair

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (AwsEc2SecurityGroupUserIdGroupPair) String added in v1.28.11 

func (s AwsEc2SecurityGroupUserIdGroupPair) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetAssignIpv6AddressOnCreation(v bool) *AwsEc2SubnetDetails

SetAssignIpv6AddressOnCreation sets the AssignIpv6AddressOnCreation field's value.

func (*AwsEc2SubnetDetails) SetAvailabilityZone added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetAvailabilityZone(v string) *AwsEc2SubnetDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsEc2SubnetDetails) SetAvailabilityZoneId added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetAvailabilityZoneId(v string) *AwsEc2SubnetDetails

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*AwsEc2SubnetDetails) SetAvailableIpAddressCount added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetAvailableIpAddressCount(v int64) *AwsEc2SubnetDetails

SetAvailableIpAddressCount sets the AvailableIpAddressCount field's value.

func (*AwsEc2SubnetDetails) SetCidrBlock added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetCidrBlock(v string) *AwsEc2SubnetDetails

SetCidrBlock sets the CidrBlock field's value.

func (*AwsEc2SubnetDetails) SetDefaultForAz added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetDefaultForAz(v bool) *AwsEc2SubnetDetails

SetDefaultForAz sets the DefaultForAz field's value.

func (*AwsEc2SubnetDetails) SetIpv6CidrBlockAssociationSet added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetIpv6CidrBlockAssociationSet(v []*Ipv6CidrBlockAssociation) *AwsEc2SubnetDetails

SetIpv6CidrBlockAssociationSet sets the Ipv6CidrBlockAssociationSet field's value.

func (*AwsEc2SubnetDetails) SetMapPublicIpOnLaunch added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetMapPublicIpOnLaunch(v bool) *AwsEc2SubnetDetails

SetMapPublicIpOnLaunch sets the MapPublicIpOnLaunch field's value.

func (*AwsEc2SubnetDetails) SetOwnerId added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetOwnerId(v string) *AwsEc2SubnetDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2SubnetDetails) SetState added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetState(v string) *AwsEc2SubnetDetails

SetState sets the State field's value.

func (*AwsEc2SubnetDetails) SetSubnetArn added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetSubnetArn(v string) *AwsEc2SubnetDetails

SetSubnetArn sets the SubnetArn field's value.

func (*AwsEc2SubnetDetails) SetSubnetId added in v1.38.31 

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

SetSubnetId sets the SubnetId field's value.

func (*AwsEc2SubnetDetails) SetVpcId added in v1.38.31 

func (s *AwsEc2SubnetDetails) SetVpcId(v string) *AwsEc2SubnetDetails

SetVpcId sets the VpcId field's value.

func (AwsEc2SubnetDetails) String added in v1.38.31 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsEc2TransitGatewayDetails) SetAmazonSideAsn(v int64) *AwsEc2TransitGatewayDetails

SetAmazonSideAsn sets the AmazonSideAsn field's value.

func (*AwsEc2TransitGatewayDetails) SetAssociationDefaultRouteTableId added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetAssociationDefaultRouteTableId(v string) *AwsEc2TransitGatewayDetails

SetAssociationDefaultRouteTableId sets the AssociationDefaultRouteTableId field's value.

func (*AwsEc2TransitGatewayDetails) SetAutoAcceptSharedAttachments added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetAutoAcceptSharedAttachments(v string) *AwsEc2TransitGatewayDetails

SetAutoAcceptSharedAttachments sets the AutoAcceptSharedAttachments field's value.

func (*AwsEc2TransitGatewayDetails) SetDefaultRouteTableAssociation added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetDefaultRouteTableAssociation(v string) *AwsEc2TransitGatewayDetails

SetDefaultRouteTableAssociation sets the DefaultRouteTableAssociation field's value.

func (*AwsEc2TransitGatewayDetails) SetDefaultRouteTablePropagation added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetDefaultRouteTablePropagation(v string) *AwsEc2TransitGatewayDetails

SetDefaultRouteTablePropagation sets the DefaultRouteTablePropagation field's value.

func (*AwsEc2TransitGatewayDetails) SetDescription added in v1.44.36 

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

SetDescription sets the Description field's value.

func (*AwsEc2TransitGatewayDetails) SetDnsSupport added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetDnsSupport(v string) *AwsEc2TransitGatewayDetails

SetDnsSupport sets the DnsSupport field's value.

func (*AwsEc2TransitGatewayDetails) SetId added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetId(v string) *AwsEc2TransitGatewayDetails

SetId sets the Id field's value.

func (*AwsEc2TransitGatewayDetails) SetMulticastSupport added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetMulticastSupport(v string) *AwsEc2TransitGatewayDetails

SetMulticastSupport sets the MulticastSupport field's value.

func (*AwsEc2TransitGatewayDetails) SetPropagationDefaultRouteTableId added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetPropagationDefaultRouteTableId(v string) *AwsEc2TransitGatewayDetails

SetPropagationDefaultRouteTableId sets the PropagationDefaultRouteTableId field's value.

func (*AwsEc2TransitGatewayDetails) SetTransitGatewayCidrBlocks added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetTransitGatewayCidrBlocks(v []*string) *AwsEc2TransitGatewayDetails

SetTransitGatewayCidrBlocks sets the TransitGatewayCidrBlocks field's value.

func (*AwsEc2TransitGatewayDetails) SetVpnEcmpSupport added in v1.44.36 

func (s *AwsEc2TransitGatewayDetails) SetVpnEcmpSupport(v string) *AwsEc2TransitGatewayDetails

SetVpnEcmpSupport sets the VpnEcmpSupport field's value.

func (AwsEc2TransitGatewayDetails) String added in v1.44.36 

func (s AwsEc2TransitGatewayDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *AwsEc2VolumeAttachment) SetAttachTime(v string) *AwsEc2VolumeAttachment

SetAttachTime sets the AttachTime field's value.

func (*AwsEc2VolumeAttachment) SetDeleteOnTermination added in v1.33.0 

func (s *AwsEc2VolumeAttachment) SetDeleteOnTermination(v bool) *AwsEc2VolumeAttachment

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2VolumeAttachment) SetInstanceId added in v1.33.0 

func (s *AwsEc2VolumeAttachment) SetInstanceId(v string) *AwsEc2VolumeAttachment

SetInstanceId sets the InstanceId field's value.

func (*AwsEc2VolumeAttachment) SetStatus added in v1.33.0 

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

SetStatus sets the Status field's value.

func (AwsEc2VolumeAttachment) String added in v1.33.0 

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 added in v1.33.0 

type AwsEc2VolumeDetails struct {

	// The volume attachments.
	Attachments []*AwsEc2VolumeAttachment `type:"list"`

	// Indicates when the volume was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.33.0 

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 added in v1.33.0 

func (s *AwsEc2VolumeDetails) SetAttachments(v []*AwsEc2VolumeAttachment) *AwsEc2VolumeDetails

SetAttachments sets the Attachments field's value.

func (*AwsEc2VolumeDetails) SetCreateTime added in v1.33.0 

func (s *AwsEc2VolumeDetails) SetCreateTime(v string) *AwsEc2VolumeDetails

SetCreateTime sets the CreateTime field's value.

func (*AwsEc2VolumeDetails) SetDeviceName added in v1.44.36 

func (s *AwsEc2VolumeDetails) SetDeviceName(v string) *AwsEc2VolumeDetails

SetDeviceName sets the DeviceName field's value.

func (*AwsEc2VolumeDetails) SetEncrypted added in v1.33.0 

func (s *AwsEc2VolumeDetails) SetEncrypted(v bool) *AwsEc2VolumeDetails

SetEncrypted sets the Encrypted field's value.

func (*AwsEc2VolumeDetails) SetKmsKeyId added in v1.33.0 

func (s *AwsEc2VolumeDetails) SetKmsKeyId(v string) *AwsEc2VolumeDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsEc2VolumeDetails) SetSize added in v1.33.0 

func (s *AwsEc2VolumeDetails) SetSize(v int64) *AwsEc2VolumeDetails

SetSize sets the Size field's value.

func (*AwsEc2VolumeDetails) SetSnapshotId added in v1.33.0 

func (s *AwsEc2VolumeDetails) SetSnapshotId(v string) *AwsEc2VolumeDetails

SetSnapshotId sets the SnapshotId field's value.

func (*AwsEc2VolumeDetails) SetStatus added in v1.33.0 

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

SetStatus sets the Status field's value.

func (*AwsEc2VolumeDetails) SetVolumeId added in v1.44.36 

func (s *AwsEc2VolumeDetails) SetVolumeId(v string) *AwsEc2VolumeDetails

SetVolumeId sets the VolumeId field's value.

func (*AwsEc2VolumeDetails) SetVolumeScanStatus added in v1.44.36 

func (s *AwsEc2VolumeDetails) SetVolumeScanStatus(v string) *AwsEc2VolumeDetails

SetVolumeScanStatus sets the VolumeScanStatus field's value.

func (*AwsEc2VolumeDetails) SetVolumeType added in v1.44.36 

func (s *AwsEc2VolumeDetails) SetVolumeType(v string) *AwsEc2VolumeDetails

SetVolumeType sets the VolumeType field's value.

func (AwsEc2VolumeDetails) String added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *AwsEc2VpcDetails) SetCidrBlockAssociationSet(v []*CidrBlockAssociation) *AwsEc2VpcDetails

SetCidrBlockAssociationSet sets the CidrBlockAssociationSet field's value.

func (*AwsEc2VpcDetails) SetDhcpOptionsId added in v1.33.0 

func (s *AwsEc2VpcDetails) SetDhcpOptionsId(v string) *AwsEc2VpcDetails

SetDhcpOptionsId sets the DhcpOptionsId field's value.

func (*AwsEc2VpcDetails) SetIpv6CidrBlockAssociationSet added in v1.33.0 

func (s *AwsEc2VpcDetails) SetIpv6CidrBlockAssociationSet(v []*Ipv6CidrBlockAssociation) *AwsEc2VpcDetails

SetIpv6CidrBlockAssociationSet sets the Ipv6CidrBlockAssociationSet field's value.

func (*AwsEc2VpcDetails) SetState added in v1.33.0 

func (s *AwsEc2VpcDetails) SetState(v string) *AwsEc2VpcDetails

SetState sets the State field's value.

func (AwsEc2VpcDetails) String added in v1.33.0 

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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsEc2VpcEndpointServiceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetAcceptanceRequired(v bool) *AwsEc2VpcEndpointServiceDetails

SetAcceptanceRequired sets the AcceptanceRequired field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetAvailabilityZones added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetAvailabilityZones(v []*string) *AwsEc2VpcEndpointServiceDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetBaseEndpointDnsNames added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetBaseEndpointDnsNames(v []*string) *AwsEc2VpcEndpointServiceDetails

SetBaseEndpointDnsNames sets the BaseEndpointDnsNames field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetGatewayLoadBalancerArns added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetGatewayLoadBalancerArns(v []*string) *AwsEc2VpcEndpointServiceDetails

SetGatewayLoadBalancerArns sets the GatewayLoadBalancerArns field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetManagesVpcEndpoints added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetManagesVpcEndpoints(v bool) *AwsEc2VpcEndpointServiceDetails

SetManagesVpcEndpoints sets the ManagesVpcEndpoints field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetNetworkLoadBalancerArns added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetNetworkLoadBalancerArns(v []*string) *AwsEc2VpcEndpointServiceDetails

SetNetworkLoadBalancerArns sets the NetworkLoadBalancerArns field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetPrivateDnsName added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetPrivateDnsName(v string) *AwsEc2VpcEndpointServiceDetails

SetPrivateDnsName sets the PrivateDnsName field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceId added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetServiceId(v string) *AwsEc2VpcEndpointServiceDetails

SetServiceId sets the ServiceId field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceName added in v1.40.59 

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

SetServiceName sets the ServiceName field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceState added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetServiceState(v string) *AwsEc2VpcEndpointServiceDetails

SetServiceState sets the ServiceState field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceType added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceDetails) SetServiceType(v []*AwsEc2VpcEndpointServiceServiceTypeDetails) *AwsEc2VpcEndpointServiceDetails

SetServiceType sets the ServiceType field's value.

func (AwsEc2VpcEndpointServiceDetails) String added in v1.40.59 

func (s AwsEc2VpcEndpointServiceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsEc2VpcEndpointServiceServiceTypeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsEc2VpcEndpointServiceServiceTypeDetails) SetServiceType(v string) *AwsEc2VpcEndpointServiceServiceTypeDetails

SetServiceType sets the ServiceType field's value.

func (AwsEc2VpcEndpointServiceServiceTypeDetails) String added in v1.40.59 

func (s AwsEc2VpcEndpointServiceServiceTypeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsEc2VpcPeeringConnectionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEc2VpcPeeringConnectionDetails) SetAccepterVpcInfo(v *AwsEc2VpcPeeringConnectionVpcInfoDetails) *AwsEc2VpcPeeringConnectionDetails

SetAccepterVpcInfo sets the AccepterVpcInfo field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetExpirationTime added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionDetails) SetExpirationTime(v string) *AwsEc2VpcPeeringConnectionDetails

SetExpirationTime sets the ExpirationTime field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetRequesterVpcInfo added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionDetails) SetRequesterVpcInfo(v *AwsEc2VpcPeeringConnectionVpcInfoDetails) *AwsEc2VpcPeeringConnectionDetails

SetRequesterVpcInfo sets the RequesterVpcInfo field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetStatus added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionDetails) SetStatus(v *AwsEc2VpcPeeringConnectionStatusDetails) *AwsEc2VpcPeeringConnectionDetails

SetStatus sets the Status field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetVpcPeeringConnectionId added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionDetails) SetVpcPeeringConnectionId(v string) *AwsEc2VpcPeeringConnectionDetails

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (AwsEc2VpcPeeringConnectionDetails) String added in v1.44.36 

func (s AwsEc2VpcPeeringConnectionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsEc2VpcPeeringConnectionStatusDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEc2VpcPeeringConnectionStatusDetails) SetCode(v string) *AwsEc2VpcPeeringConnectionStatusDetails

SetCode sets the Code field's value.

func (*AwsEc2VpcPeeringConnectionStatusDetails) SetMessage added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionStatusDetails) SetMessage(v string) *AwsEc2VpcPeeringConnectionStatusDetails

SetMessage sets the Message field's value.

func (AwsEc2VpcPeeringConnectionStatusDetails) String added in v1.44.36 

func (s AwsEc2VpcPeeringConnectionStatusDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsEc2VpcPeeringConnectionVpcInfoDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetCidrBlock(v string) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetCidrBlock sets the CidrBlock field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetCidrBlockSet added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetCidrBlockSet(v []*VpcInfoCidrBlockSetDetails) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetCidrBlockSet sets the CidrBlockSet field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetIpv6CidrBlockSet added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetIpv6CidrBlockSet(v []*VpcInfoIpv6CidrBlockSetDetails) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetIpv6CidrBlockSet sets the Ipv6CidrBlockSet field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetOwnerId added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetOwnerId(v string) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetPeeringOptions added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetPeeringOptions(v *VpcInfoPeeringOptionsDetails) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetPeeringOptions sets the PeeringOptions field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetRegion added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetRegion(v string) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetRegion sets the Region field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetVpcId added in v1.44.36 

func (s *AwsEc2VpcPeeringConnectionVpcInfoDetails) SetVpcId(v string) *AwsEc2VpcPeeringConnectionVpcInfoDetails

SetVpcId sets the VpcId field's value.

func (AwsEc2VpcPeeringConnectionVpcInfoDetails) String added in v1.44.36 

func (s AwsEc2VpcPeeringConnectionVpcInfoDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

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 added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetCategory(v string) *AwsEc2VpnConnectionDetails

SetCategory sets the Category field's value.

func (*AwsEc2VpnConnectionDetails) SetCustomerGatewayConfiguration added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetCustomerGatewayConfiguration(v string) *AwsEc2VpnConnectionDetails

SetCustomerGatewayConfiguration sets the CustomerGatewayConfiguration field's value.

func (*AwsEc2VpnConnectionDetails) SetCustomerGatewayId added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetCustomerGatewayId(v string) *AwsEc2VpnConnectionDetails

SetCustomerGatewayId sets the CustomerGatewayId field's value.

func (*AwsEc2VpnConnectionDetails) SetOptions added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetOptions(v *AwsEc2VpnConnectionOptionsDetails) *AwsEc2VpnConnectionDetails

SetOptions sets the Options field's value.

func (*AwsEc2VpnConnectionDetails) SetRoutes added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetRoutes(v []*AwsEc2VpnConnectionRoutesDetails) *AwsEc2VpnConnectionDetails

SetRoutes sets the Routes field's value.

func (*AwsEc2VpnConnectionDetails) SetState added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetState(v string) *AwsEc2VpnConnectionDetails

SetState sets the State field's value.

func (*AwsEc2VpnConnectionDetails) SetTransitGatewayId added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetTransitGatewayId(v string) *AwsEc2VpnConnectionDetails

SetTransitGatewayId sets the TransitGatewayId field's value.

func (*AwsEc2VpnConnectionDetails) SetType added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetType(v string) *AwsEc2VpnConnectionDetails

SetType sets the Type field's value.

func (*AwsEc2VpnConnectionDetails) SetVgwTelemetry added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetVgwTelemetry(v []*AwsEc2VpnConnectionVgwTelemetryDetails) *AwsEc2VpnConnectionDetails

SetVgwTelemetry sets the VgwTelemetry field's value.

func (*AwsEc2VpnConnectionDetails) SetVpnConnectionId added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetVpnConnectionId(v string) *AwsEc2VpnConnectionDetails

SetVpnConnectionId sets the VpnConnectionId field's value.

func (*AwsEc2VpnConnectionDetails) SetVpnGatewayId added in v1.40.36 

func (s *AwsEc2VpnConnectionDetails) SetVpnGatewayId(v string) *AwsEc2VpnConnectionDetails

SetVpnGatewayId sets the VpnGatewayId field's value.

func (AwsEc2VpnConnectionDetails) String added in v1.40.36 

func (s AwsEc2VpnConnectionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsEc2VpnConnectionOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsDetails) SetStaticRoutesOnly(v bool) *AwsEc2VpnConnectionOptionsDetails

SetStaticRoutesOnly sets the StaticRoutesOnly field's value.

func (*AwsEc2VpnConnectionOptionsDetails) SetTunnelOptions added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsDetails) SetTunnelOptions(v []*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) *AwsEc2VpnConnectionOptionsDetails

SetTunnelOptions sets the TunnelOptions field's value.

func (AwsEc2VpnConnectionOptionsDetails) String added in v1.40.36 

func (s AwsEc2VpnConnectionOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsEc2VpnConnectionOptionsTunnelOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetDpdTimeoutSeconds(v int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetDpdTimeoutSeconds sets the DpdTimeoutSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetIkeVersions added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetIkeVersions(v []*string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetIkeVersions sets the IkeVersions field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetOutsideIpAddress added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetOutsideIpAddress(v string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetOutsideIpAddress sets the OutsideIpAddress field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1DhGroupNumbers added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1DhGroupNumbers(v []*int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase1DhGroupNumbers sets the Phase1DhGroupNumbers field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1EncryptionAlgorithms added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1EncryptionAlgorithms(v []*string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase1EncryptionAlgorithms sets the Phase1EncryptionAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1IntegrityAlgorithms added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1IntegrityAlgorithms(v []*string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase1IntegrityAlgorithms sets the Phase1IntegrityAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1LifetimeSeconds added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1LifetimeSeconds(v int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase1LifetimeSeconds sets the Phase1LifetimeSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2DhGroupNumbers added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2DhGroupNumbers(v []*int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase2DhGroupNumbers sets the Phase2DhGroupNumbers field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2EncryptionAlgorithms added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2EncryptionAlgorithms(v []*string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase2EncryptionAlgorithms sets the Phase2EncryptionAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2IntegrityAlgorithms added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2IntegrityAlgorithms(v []*string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase2IntegrityAlgorithms sets the Phase2IntegrityAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2LifetimeSeconds added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2LifetimeSeconds(v int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPhase2LifetimeSeconds sets the Phase2LifetimeSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPreSharedKey added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPreSharedKey(v string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetPreSharedKey sets the PreSharedKey field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetRekeyFuzzPercentage added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetRekeyFuzzPercentage(v int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetRekeyFuzzPercentage sets the RekeyFuzzPercentage field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetRekeyMarginTimeSeconds added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetRekeyMarginTimeSeconds(v int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetRekeyMarginTimeSeconds sets the RekeyMarginTimeSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetReplayWindowSize added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetReplayWindowSize(v int64) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetReplayWindowSize sets the ReplayWindowSize field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetTunnelInsideCidr added in v1.40.36 

func (s *AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetTunnelInsideCidr(v string) *AwsEc2VpnConnectionOptionsTunnelOptionsDetails

SetTunnelInsideCidr sets the TunnelInsideCidr field's value.

func (AwsEc2VpnConnectionOptionsTunnelOptionsDetails) String added in v1.40.36 

func (s AwsEc2VpnConnectionOptionsTunnelOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsEc2VpnConnectionRoutesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsEc2VpnConnectionRoutesDetails) SetDestinationCidrBlock(v string) *AwsEc2VpnConnectionRoutesDetails

SetDestinationCidrBlock sets the DestinationCidrBlock field's value.

func (*AwsEc2VpnConnectionRoutesDetails) SetState added in v1.40.36 

func (s *AwsEc2VpnConnectionRoutesDetails) SetState(v string) *AwsEc2VpnConnectionRoutesDetails

SetState sets the State field's value.

func (AwsEc2VpnConnectionRoutesDetails) String added in v1.40.36 

func (s AwsEc2VpnConnectionRoutesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.40.36 

func (s AwsEc2VpnConnectionVgwTelemetryDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsEc2VpnConnectionVgwTelemetryDetails) SetAcceptedRouteCount(v int64) *AwsEc2VpnConnectionVgwTelemetryDetails

SetAcceptedRouteCount sets the AcceptedRouteCount field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetCertificateArn added in v1.40.36 

func (s *AwsEc2VpnConnectionVgwTelemetryDetails) SetCertificateArn(v string) *AwsEc2VpnConnectionVgwTelemetryDetails

SetCertificateArn sets the CertificateArn field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetLastStatusChange added in v1.40.36 

func (s *AwsEc2VpnConnectionVgwTelemetryDetails) SetLastStatusChange(v string) *AwsEc2VpnConnectionVgwTelemetryDetails

SetLastStatusChange sets the LastStatusChange field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetOutsideIpAddress added in v1.40.36 

func (s *AwsEc2VpnConnectionVgwTelemetryDetails) SetOutsideIpAddress(v string) *AwsEc2VpnConnectionVgwTelemetryDetails

SetOutsideIpAddress sets the OutsideIpAddress field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetStatus added in v1.40.36 

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

SetStatus sets the Status field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetStatusMessage added in v1.40.36 

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

SetStatusMessage sets the StatusMessage field's value.

func (AwsEc2VpnConnectionVgwTelemetryDetails) String added in v1.40.36 

func (s AwsEc2VpnConnectionVgwTelemetryDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.40.36 

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 added in v1.40.36 

func (s *AwsEcrContainerImageDetails) SetArchitecture(v string) *AwsEcrContainerImageDetails

SetArchitecture sets the Architecture field's value.

func (*AwsEcrContainerImageDetails) SetImageDigest added in v1.40.36 

func (s *AwsEcrContainerImageDetails) SetImageDigest(v string) *AwsEcrContainerImageDetails

SetImageDigest sets the ImageDigest field's value.

func (*AwsEcrContainerImageDetails) SetImagePublishedAt added in v1.40.36 

func (s *AwsEcrContainerImageDetails) SetImagePublishedAt(v string) *AwsEcrContainerImageDetails

SetImagePublishedAt sets the ImagePublishedAt field's value.

func (*AwsEcrContainerImageDetails) SetImageTags added in v1.40.36 

func (s *AwsEcrContainerImageDetails) SetImageTags(v []*string) *AwsEcrContainerImageDetails

SetImageTags sets the ImageTags field's value.

func (*AwsEcrContainerImageDetails) SetRegistryId added in v1.40.36 

func (s *AwsEcrContainerImageDetails) SetRegistryId(v string) *AwsEcrContainerImageDetails

SetRegistryId sets the RegistryId field's value.

func (*AwsEcrContainerImageDetails) SetRepositoryName added in v1.40.36 

func (s *AwsEcrContainerImageDetails) SetRepositoryName(v string) *AwsEcrContainerImageDetails

SetRepositoryName sets the RepositoryName field's value.

func (AwsEcrContainerImageDetails) String added in v1.40.36 

func (s AwsEcrContainerImageDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

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 added in v1.40.59 

func (s *AwsEcrRepositoryDetails) SetArn(v string) *AwsEcrRepositoryDetails

SetArn sets the Arn field's value.

func (*AwsEcrRepositoryDetails) SetImageScanningConfiguration added in v1.40.59 

func (s *AwsEcrRepositoryDetails) SetImageScanningConfiguration(v *AwsEcrRepositoryImageScanningConfigurationDetails) *AwsEcrRepositoryDetails

SetImageScanningConfiguration sets the ImageScanningConfiguration field's value.

func (*AwsEcrRepositoryDetails) SetImageTagMutability added in v1.40.59 

func (s *AwsEcrRepositoryDetails) SetImageTagMutability(v string) *AwsEcrRepositoryDetails

SetImageTagMutability sets the ImageTagMutability field's value.

func (*AwsEcrRepositoryDetails) SetLifecyclePolicy added in v1.40.59 

func (s *AwsEcrRepositoryDetails) SetLifecyclePolicy(v *AwsEcrRepositoryLifecyclePolicyDetails) *AwsEcrRepositoryDetails

SetLifecyclePolicy sets the LifecyclePolicy field's value.

func (*AwsEcrRepositoryDetails) SetRepositoryName added in v1.40.59 

func (s *AwsEcrRepositoryDetails) SetRepositoryName(v string) *AwsEcrRepositoryDetails

SetRepositoryName sets the RepositoryName field's value.

func (*AwsEcrRepositoryDetails) SetRepositoryPolicyText added in v1.40.59 

func (s *AwsEcrRepositoryDetails) SetRepositoryPolicyText(v string) *AwsEcrRepositoryDetails

SetRepositoryPolicyText sets the RepositoryPolicyText field's value.

func (AwsEcrRepositoryDetails) String added in v1.40.59 

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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsEcrRepositoryImageScanningConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsEcrRepositoryImageScanningConfigurationDetails) SetScanOnPush(v bool) *AwsEcrRepositoryImageScanningConfigurationDetails

SetScanOnPush sets the ScanOnPush field's value.

func (AwsEcrRepositoryImageScanningConfigurationDetails) String added in v1.40.59 

func (s AwsEcrRepositoryImageScanningConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsEcrRepositoryLifecyclePolicyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsEcrRepositoryLifecyclePolicyDetails) SetLifecyclePolicyText(v string) *AwsEcrRepositoryLifecyclePolicyDetails

SetLifecyclePolicyText sets the LifecyclePolicyText field's value.

func (*AwsEcrRepositoryLifecyclePolicyDetails) SetRegistryId added in v1.40.59 

func (s *AwsEcrRepositoryLifecyclePolicyDetails) SetRegistryId(v string) *AwsEcrRepositoryLifecyclePolicyDetails

SetRegistryId sets the RegistryId field's value.

func (AwsEcrRepositoryLifecyclePolicyDetails) String added in v1.40.59 

func (s AwsEcrRepositoryLifecyclePolicyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsClusterClusterSettingsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsClusterClusterSettingsDetails) SetValue added in v1.38.67 

func (s *AwsEcsClusterClusterSettingsDetails) SetValue(v string) *AwsEcsClusterClusterSettingsDetails

SetValue sets the Value field's value.

func (AwsEcsClusterClusterSettingsDetails) String added in v1.38.67 

func (s AwsEcsClusterClusterSettingsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsClusterConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsClusterConfigurationDetails) SetExecuteCommandConfiguration(v *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) *AwsEcsClusterConfigurationDetails

SetExecuteCommandConfiguration sets the ExecuteCommandConfiguration field's value.

func (AwsEcsClusterConfigurationDetails) String added in v1.38.67 

func (s AwsEcsClusterConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetKmsKeyId(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogConfiguration added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogConfiguration(v *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails

SetLogConfiguration sets the LogConfiguration field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogging added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogging(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails

SetLogging sets the Logging field's value.

func (AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) String added in v1.38.67 

func (s AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchEncryptionEnabled(v bool) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails

SetCloudWatchEncryptionEnabled sets the CloudWatchEncryptionEnabled field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchLogGroupName added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchLogGroupName(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails

SetCloudWatchLogGroupName sets the CloudWatchLogGroupName field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3BucketName added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3BucketName(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails

SetS3BucketName sets the S3BucketName field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3EncryptionEnabled added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3EncryptionEnabled(v bool) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails

SetS3EncryptionEnabled sets the S3EncryptionEnabled field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3KeyPrefix added in v1.38.67 

func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3KeyPrefix(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) String added in v1.38.67 

func (s AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsClusterDefaultCapacityProviderStrategyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetBase(v int64) *AwsEcsClusterDefaultCapacityProviderStrategyDetails

SetBase sets the Base field's value.

func (*AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetCapacityProvider added in v1.38.67 

func (s *AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetCapacityProvider(v string) *AwsEcsClusterDefaultCapacityProviderStrategyDetails

SetCapacityProvider sets the CapacityProvider field's value.

func (*AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetWeight added in v1.38.67 

func (s *AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetWeight(v int64) *AwsEcsClusterDefaultCapacityProviderStrategyDetails

SetWeight sets the Weight field's value.

func (AwsEcsClusterDefaultCapacityProviderStrategyDetails) String added in v1.38.67 

func (s AwsEcsClusterDefaultCapacityProviderStrategyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

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.44.36 

func (s *AwsEcsClusterDetails) SetActiveServicesCount(v int64) *AwsEcsClusterDetails

SetActiveServicesCount sets the ActiveServicesCount field's value.

func (*AwsEcsClusterDetails) SetCapacityProviders added in v1.38.67 

func (s *AwsEcsClusterDetails) SetCapacityProviders(v []*string) *AwsEcsClusterDetails

SetCapacityProviders sets the CapacityProviders field's value.

func (*AwsEcsClusterDetails) SetClusterArn added in v1.44.36 

func (s *AwsEcsClusterDetails) SetClusterArn(v string) *AwsEcsClusterDetails

SetClusterArn sets the ClusterArn field's value.

func (*AwsEcsClusterDetails) SetClusterName added in v1.44.36 

func (s *AwsEcsClusterDetails) SetClusterName(v string) *AwsEcsClusterDetails

SetClusterName sets the ClusterName field's value.

func (*AwsEcsClusterDetails) SetClusterSettings added in v1.38.67 

func (s *AwsEcsClusterDetails) SetClusterSettings(v []*AwsEcsClusterClusterSettingsDetails) *AwsEcsClusterDetails

SetClusterSettings sets the ClusterSettings field's value.

func (*AwsEcsClusterDetails) SetConfiguration added in v1.38.67 

func (s *AwsEcsClusterDetails) SetConfiguration(v *AwsEcsClusterConfigurationDetails) *AwsEcsClusterDetails

SetConfiguration sets the Configuration field's value.

func (*AwsEcsClusterDetails) SetDefaultCapacityProviderStrategy added in v1.38.67 

func (s *AwsEcsClusterDetails) SetDefaultCapacityProviderStrategy(v []*AwsEcsClusterDefaultCapacityProviderStrategyDetails) *AwsEcsClusterDetails

SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.

func (*AwsEcsClusterDetails) SetRegisteredContainerInstancesCount added in v1.44.36 

func (s *AwsEcsClusterDetails) SetRegisteredContainerInstancesCount(v int64) *AwsEcsClusterDetails

SetRegisteredContainerInstancesCount sets the RegisteredContainerInstancesCount field's value.

func (*AwsEcsClusterDetails) SetRunningTasksCount added in v1.44.36 

func (s *AwsEcsClusterDetails) SetRunningTasksCount(v int64) *AwsEcsClusterDetails

SetRunningTasksCount sets the RunningTasksCount field's value.

func (*AwsEcsClusterDetails) SetStatus added in v1.44.36 

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

SetStatus sets the Status field's value.

func (AwsEcsClusterDetails) String added in v1.38.67 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsEcsContainerDetails) SetImage(v string) *AwsEcsContainerDetails

SetImage sets the Image field's value.

func (*AwsEcsContainerDetails) SetMountPoints added in v1.44.36 

func (s *AwsEcsContainerDetails) SetMountPoints(v []*AwsMountPoint) *AwsEcsContainerDetails

SetMountPoints sets the MountPoints field's value.

func (*AwsEcsContainerDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsEcsContainerDetails) SetPrivileged added in v1.44.36 

func (s *AwsEcsContainerDetails) SetPrivileged(v bool) *AwsEcsContainerDetails

SetPrivileged sets the Privileged field's value.

func (AwsEcsContainerDetails) String added in v1.44.36 

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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceCapacityProviderStrategyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceCapacityProviderStrategyDetails) SetBase(v int64) *AwsEcsServiceCapacityProviderStrategyDetails

SetBase sets the Base field's value.

func (*AwsEcsServiceCapacityProviderStrategyDetails) SetCapacityProvider added in v1.40.7 

func (s *AwsEcsServiceCapacityProviderStrategyDetails) SetCapacityProvider(v string) *AwsEcsServiceCapacityProviderStrategyDetails

SetCapacityProvider sets the CapacityProvider field's value.

func (*AwsEcsServiceCapacityProviderStrategyDetails) SetWeight added in v1.40.7 

func (s *AwsEcsServiceCapacityProviderStrategyDetails) SetWeight(v int64) *AwsEcsServiceCapacityProviderStrategyDetails

SetWeight sets the Weight field's value.

func (AwsEcsServiceCapacityProviderStrategyDetails) String added in v1.40.7 

func (s AwsEcsServiceCapacityProviderStrategyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) SetEnable(v bool) *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails

SetEnable sets the Enable field's value.

func (*AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) SetRollback added in v1.40.7 

func (s *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) SetRollback(v bool) *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails

SetRollback sets the Rollback field's value.

func (AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) String added in v1.40.7 

func (s AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceDeploymentConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceDeploymentConfigurationDetails) SetDeploymentCircuitBreaker(v *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) *AwsEcsServiceDeploymentConfigurationDetails

SetDeploymentCircuitBreaker sets the DeploymentCircuitBreaker field's value.

func (*AwsEcsServiceDeploymentConfigurationDetails) SetMaximumPercent added in v1.40.7 

func (s *AwsEcsServiceDeploymentConfigurationDetails) SetMaximumPercent(v int64) *AwsEcsServiceDeploymentConfigurationDetails

SetMaximumPercent sets the MaximumPercent field's value.

func (*AwsEcsServiceDeploymentConfigurationDetails) SetMinimumHealthyPercent added in v1.40.7 

func (s *AwsEcsServiceDeploymentConfigurationDetails) SetMinimumHealthyPercent(v int64) *AwsEcsServiceDeploymentConfigurationDetails

SetMinimumHealthyPercent sets the MinimumHealthyPercent field's value.

func (AwsEcsServiceDeploymentConfigurationDetails) String added in v1.40.7 

func (s AwsEcsServiceDeploymentConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceDeploymentControllerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceDeploymentControllerDetails) SetType(v string) *AwsEcsServiceDeploymentControllerDetails

SetType sets the Type field's value.

func (AwsEcsServiceDeploymentControllerDetails) String added in v1.40.7 

func (s AwsEcsServiceDeploymentControllerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

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 added in v1.40.7 

func (s *AwsEcsServiceDetails) SetCapacityProviderStrategy(v []*AwsEcsServiceCapacityProviderStrategyDetails) *AwsEcsServiceDetails

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*AwsEcsServiceDetails) SetCluster added in v1.40.7 

func (s *AwsEcsServiceDetails) SetCluster(v string) *AwsEcsServiceDetails

SetCluster sets the Cluster field's value.

func (*AwsEcsServiceDetails) SetDeploymentConfiguration added in v1.40.7 

func (s *AwsEcsServiceDetails) SetDeploymentConfiguration(v *AwsEcsServiceDeploymentConfigurationDetails) *AwsEcsServiceDetails

SetDeploymentConfiguration sets the DeploymentConfiguration field's value.

func (*AwsEcsServiceDetails) SetDeploymentController added in v1.40.7 

func (s *AwsEcsServiceDetails) SetDeploymentController(v *AwsEcsServiceDeploymentControllerDetails) *AwsEcsServiceDetails

SetDeploymentController sets the DeploymentController field's value.

func (*AwsEcsServiceDetails) SetDesiredCount added in v1.40.7 

func (s *AwsEcsServiceDetails) SetDesiredCount(v int64) *AwsEcsServiceDetails

SetDesiredCount sets the DesiredCount field's value.

func (*AwsEcsServiceDetails) SetEnableEcsManagedTags added in v1.40.7 

func (s *AwsEcsServiceDetails) SetEnableEcsManagedTags(v bool) *AwsEcsServiceDetails

SetEnableEcsManagedTags sets the EnableEcsManagedTags field's value.

func (*AwsEcsServiceDetails) SetEnableExecuteCommand added in v1.40.7 

func (s *AwsEcsServiceDetails) SetEnableExecuteCommand(v bool) *AwsEcsServiceDetails

SetEnableExecuteCommand sets the EnableExecuteCommand field's value.

func (*AwsEcsServiceDetails) SetHealthCheckGracePeriodSeconds added in v1.40.7 

func (s *AwsEcsServiceDetails) SetHealthCheckGracePeriodSeconds(v int64) *AwsEcsServiceDetails

SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value.

func (*AwsEcsServiceDetails) SetLaunchType added in v1.40.7 

func (s *AwsEcsServiceDetails) SetLaunchType(v string) *AwsEcsServiceDetails

SetLaunchType sets the LaunchType field's value.

func (*AwsEcsServiceDetails) SetLoadBalancers added in v1.40.7 

func (s *AwsEcsServiceDetails) SetLoadBalancers(v []*AwsEcsServiceLoadBalancersDetails) *AwsEcsServiceDetails

SetLoadBalancers sets the LoadBalancers field's value.

func (*AwsEcsServiceDetails) SetName added in v1.40.7 

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

SetName sets the Name field's value.

func (*AwsEcsServiceDetails) SetNetworkConfiguration added in v1.40.7 

func (s *AwsEcsServiceDetails) SetNetworkConfiguration(v *AwsEcsServiceNetworkConfigurationDetails) *AwsEcsServiceDetails

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*AwsEcsServiceDetails) SetPlacementConstraints added in v1.40.7 

func (s *AwsEcsServiceDetails) SetPlacementConstraints(v []*AwsEcsServicePlacementConstraintsDetails) *AwsEcsServiceDetails

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*AwsEcsServiceDetails) SetPlacementStrategies added in v1.40.7 

func (s *AwsEcsServiceDetails) SetPlacementStrategies(v []*AwsEcsServicePlacementStrategiesDetails) *AwsEcsServiceDetails

SetPlacementStrategies sets the PlacementStrategies field's value.

func (*AwsEcsServiceDetails) SetPlatformVersion added in v1.40.7 

func (s *AwsEcsServiceDetails) SetPlatformVersion(v string) *AwsEcsServiceDetails

SetPlatformVersion sets the PlatformVersion field's value.

func (*AwsEcsServiceDetails) SetPropagateTags added in v1.40.7 

func (s *AwsEcsServiceDetails) SetPropagateTags(v string) *AwsEcsServiceDetails

SetPropagateTags sets the PropagateTags field's value.

func (*AwsEcsServiceDetails) SetRole added in v1.40.7 

func (s *AwsEcsServiceDetails) SetRole(v string) *AwsEcsServiceDetails

SetRole sets the Role field's value.

func (*AwsEcsServiceDetails) SetSchedulingStrategy added in v1.40.7 

func (s *AwsEcsServiceDetails) SetSchedulingStrategy(v string) *AwsEcsServiceDetails

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (*AwsEcsServiceDetails) SetServiceArn added in v1.40.7 

func (s *AwsEcsServiceDetails) SetServiceArn(v string) *AwsEcsServiceDetails

SetServiceArn sets the ServiceArn field's value.

func (*AwsEcsServiceDetails) SetServiceName added in v1.40.7 

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

SetServiceName sets the ServiceName field's value.

func (*AwsEcsServiceDetails) SetServiceRegistries added in v1.40.7 

func (s *AwsEcsServiceDetails) SetServiceRegistries(v []*AwsEcsServiceServiceRegistriesDetails) *AwsEcsServiceDetails

SetServiceRegistries sets the ServiceRegistries field's value.

func (*AwsEcsServiceDetails) SetTaskDefinition added in v1.40.7 

func (s *AwsEcsServiceDetails) SetTaskDefinition(v string) *AwsEcsServiceDetails

SetTaskDefinition sets the TaskDefinition field's value.

func (AwsEcsServiceDetails) String added in v1.40.7 

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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceLoadBalancersDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceLoadBalancersDetails) SetContainerName(v string) *AwsEcsServiceLoadBalancersDetails

SetContainerName sets the ContainerName field's value.

func (*AwsEcsServiceLoadBalancersDetails) SetContainerPort added in v1.40.7 

func (s *AwsEcsServiceLoadBalancersDetails) SetContainerPort(v int64) *AwsEcsServiceLoadBalancersDetails

SetContainerPort sets the ContainerPort field's value.

func (*AwsEcsServiceLoadBalancersDetails) SetLoadBalancerName added in v1.40.7 

func (s *AwsEcsServiceLoadBalancersDetails) SetLoadBalancerName(v string) *AwsEcsServiceLoadBalancersDetails

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*AwsEcsServiceLoadBalancersDetails) SetTargetGroupArn added in v1.40.7 

func (s *AwsEcsServiceLoadBalancersDetails) SetTargetGroupArn(v string) *AwsEcsServiceLoadBalancersDetails

SetTargetGroupArn sets the TargetGroupArn field's value.

func (AwsEcsServiceLoadBalancersDetails) String added in v1.40.7 

func (s AwsEcsServiceLoadBalancersDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetAssignPublicIp(v string) *AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails

SetAssignPublicIp sets the AssignPublicIp field's value.

func (*AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetSecurityGroups added in v1.40.7 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetSubnets added in v1.40.7 

func (s *AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetSubnets(v []*string) *AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails

SetSubnets sets the Subnets field's value.

func (AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) String added in v1.40.7 

func (s AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceNetworkConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceNetworkConfigurationDetails) SetAwsVpcConfiguration(v *AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) *AwsEcsServiceNetworkConfigurationDetails

SetAwsVpcConfiguration sets the AwsVpcConfiguration field's value.

func (AwsEcsServiceNetworkConfigurationDetails) String added in v1.40.7 

func (s AwsEcsServiceNetworkConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServicePlacementConstraintsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServicePlacementConstraintsDetails) SetExpression(v string) *AwsEcsServicePlacementConstraintsDetails

SetExpression sets the Expression field's value.

func (*AwsEcsServicePlacementConstraintsDetails) SetType added in v1.40.7 

func (s *AwsEcsServicePlacementConstraintsDetails) SetType(v string) *AwsEcsServicePlacementConstraintsDetails

SetType sets the Type field's value.

func (AwsEcsServicePlacementConstraintsDetails) String added in v1.40.7 

func (s AwsEcsServicePlacementConstraintsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServicePlacementStrategiesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServicePlacementStrategiesDetails) SetField(v string) *AwsEcsServicePlacementStrategiesDetails

SetField sets the Field field's value.

func (*AwsEcsServicePlacementStrategiesDetails) SetType added in v1.40.7 

func (s *AwsEcsServicePlacementStrategiesDetails) SetType(v string) *AwsEcsServicePlacementStrategiesDetails

SetType sets the Type field's value.

func (AwsEcsServicePlacementStrategiesDetails) String added in v1.40.7 

func (s AwsEcsServicePlacementStrategiesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsEcsServiceServiceRegistriesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsEcsServiceServiceRegistriesDetails) SetContainerName(v string) *AwsEcsServiceServiceRegistriesDetails

SetContainerName sets the ContainerName field's value.

func (*AwsEcsServiceServiceRegistriesDetails) SetContainerPort added in v1.40.7 

func (s *AwsEcsServiceServiceRegistriesDetails) SetContainerPort(v int64) *AwsEcsServiceServiceRegistriesDetails

SetContainerPort sets the ContainerPort field's value.

func (*AwsEcsServiceServiceRegistriesDetails) SetPort added in v1.40.7 

func (s *AwsEcsServiceServiceRegistriesDetails) SetPort(v int64) *AwsEcsServiceServiceRegistriesDetails

SetPort sets the Port field's value.

func (*AwsEcsServiceServiceRegistriesDetails) SetRegistryArn added in v1.40.7 

func (s *AwsEcsServiceServiceRegistriesDetails) SetRegistryArn(v string) *AwsEcsServiceServiceRegistriesDetails

SetRegistryArn sets the RegistryArn field's value.

func (AwsEcsServiceServiceRegistriesDetails) String added in v1.40.7 

func (s AwsEcsServiceServiceRegistriesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetCondition(v string) *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails

SetCondition sets the Condition field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetContainerName added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetContainerName(v string) *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails

SetContainerName sets the ContainerName field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCommand(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetCommand sets the Command field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCpu added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCpu(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetCpu sets the Cpu field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDependsOn added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDependsOn(v []*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetDependsOn sets the DependsOn field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDisableNetworking added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDisableNetworking(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetDisableNetworking sets the DisableNetworking field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsSearchDomains added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsSearchDomains(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetDnsSearchDomains sets the DnsSearchDomains field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsServers added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsServers(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetDnsServers sets the DnsServers field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerLabels added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerLabels(v map[string]*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetDockerLabels sets the DockerLabels field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerSecurityOptions added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerSecurityOptions(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetDockerSecurityOptions sets the DockerSecurityOptions field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEntryPoint added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEntryPoint(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetEntryPoint sets the EntryPoint field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironment added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironment(v []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetEnvironment sets the Environment field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironmentFiles added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironmentFiles(v []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetEnvironmentFiles sets the EnvironmentFiles field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEssential added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEssential(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetEssential sets the Essential field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetExtraHosts added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetExtraHosts(v []*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetExtraHosts sets the ExtraHosts field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetFirelensConfiguration added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetFirelensConfiguration(v *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetFirelensConfiguration sets the FirelensConfiguration field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHealthCheck added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHealthCheck(v *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetHealthCheck sets the HealthCheck field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHostname added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHostname(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetHostname sets the Hostname field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetImage added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetImage(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetImage sets the Image field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetInteractive added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetInteractive(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetInteractive sets the Interactive field's value. 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLinks(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetLinks sets the Links field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLinuxParameters added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLinuxParameters(v *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetLinuxParameters sets the LinuxParameters field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLogConfiguration added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLogConfiguration(v *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetLogConfiguration sets the LogConfiguration field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemory added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemory(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetMemory sets the Memory field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemoryReservation added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemoryReservation(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetMemoryReservation sets the MemoryReservation field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMountPoints added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMountPoints(v []*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetMountPoints sets the MountPoints field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetName added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPortMappings added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPortMappings(v []*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetPortMappings sets the PortMappings field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPrivileged added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPrivileged(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetPrivileged sets the Privileged field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPseudoTerminal added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPseudoTerminal(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetPseudoTerminal sets the PseudoTerminal field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetReadonlyRootFilesystem added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetReadonlyRootFilesystem(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetRepositoryCredentials added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetRepositoryCredentials(v *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetRepositoryCredentials sets the RepositoryCredentials field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetResourceRequirements added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetResourceRequirements(v []*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetResourceRequirements sets the ResourceRequirements field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSecrets added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSecrets(v []*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetSecrets sets the Secrets field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStartTimeout added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStartTimeout(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetStartTimeout sets the StartTimeout field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStopTimeout added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStopTimeout(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetStopTimeout sets the StopTimeout field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSystemControls added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSystemControls(v []*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetSystemControls sets the SystemControls field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUlimits added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUlimits(v []*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetUlimits sets the Ulimits field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUser added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUser(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetUser sets the User field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetVolumesFrom added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetVolumesFrom(v []*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetVolumesFrom sets the VolumesFrom field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetWorkingDirectory added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetWorkingDirectory(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails

SetWorkingDirectory sets the WorkingDirectory field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetValue added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetType(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails

SetType sets the Type field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetValue added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetHostname(v string) *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails

SetHostname sets the Hostname field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetIpAddress added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetIpAddress(v string) *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails

SetIpAddress sets the IpAddress field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetOptions(v map[string]*string) *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails

SetOptions sets the Options field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetType added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetType(v string) *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails

SetType sets the Type field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetCommand(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

SetCommand sets the Command field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetInterval added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetInterval(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

SetInterval sets the Interval field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetRetries added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetRetries(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

SetRetries sets the Retries field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetStartPeriod added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetStartPeriod(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

SetStartPeriod sets the StartPeriod field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetTimeout added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetTimeout(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

SetTimeout sets the Timeout field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetAdd(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails

SetAdd sets the Add field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetDrop added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetDrop(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails

SetDrop sets the Drop field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetCapabilities(v *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetCapabilities sets the Capabilities field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetDevices added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetDevices(v []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetDevices sets the Devices field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetInitProcessEnabled added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetInitProcessEnabled(v bool) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetInitProcessEnabled sets the InitProcessEnabled field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetMaxSwap added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetMaxSwap(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetMaxSwap sets the MaxSwap field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSharedMemorySize added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSharedMemorySize(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetSharedMemorySize sets the SharedMemorySize field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSwappiness added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSwappiness(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetSwappiness sets the Swappiness field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetTmpfs added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetTmpfs(v []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

SetTmpfs sets the Tmpfs field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetContainerPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails

SetContainerPath sets the ContainerPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetHostPath added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetHostPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails

SetHostPath sets the HostPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetPermissions added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetPermissions(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails

SetPermissions sets the Permissions field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetContainerPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails

SetContainerPath sets the ContainerPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetMountOptions added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetMountOptions(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails

SetMountOptions sets the MountOptions field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetSize added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetSize(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails

SetSize sets the Size field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetLogDriver(v string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails

SetLogDriver sets the LogDriver field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetOptions added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetOptions(v map[string]*string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails

SetOptions sets the Options field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetSecretOptions added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetSecretOptions(v []*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails

SetSecretOptions sets the SecretOptions field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) SetValueFrom added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) SetValueFrom(v string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails

SetValueFrom sets the ValueFrom field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetContainerPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails

SetContainerPath sets the ContainerPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetReadOnly added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetReadOnly(v bool) *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails

SetReadOnly sets the ReadOnly field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetSourceVolume added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetSourceVolume(v string) *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails

SetSourceVolume sets the SourceVolume field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetContainerPort(v int64) *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails

SetContainerPort sets the ContainerPort field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetHostPort added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetHostPort(v int64) *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails

SetHostPort sets the HostPort field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetProtocol added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetProtocol(v string) *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails

SetProtocol sets the Protocol field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) SetCredentialsParameter(v string) *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails

SetCredentialsParameter sets the CredentialsParameter field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetType(v string) *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails

SetType sets the Type field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetValue added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) SetValueFrom added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) SetValueFrom(v string) *AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails

SetValueFrom sets the ValueFrom field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetNamespace(v string) *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails

SetNamespace sets the Namespace field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetValue added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetHardLimit(v int64) *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails

SetHardLimit sets the HardLimit field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetName added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetSoftLimit added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetSoftLimit(v int64) *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails

SetSoftLimit sets the SoftLimit field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetReadOnly(v bool) *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails

SetReadOnly sets the ReadOnly field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetSourceContainer added in v1.38.67 

func (s *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetSourceContainer(v string) *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails

SetSourceContainer sets the SourceContainer field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 status of the task definition.
	Status *string `type:"string"`

	// 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 added in v1.38.67 

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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetContainerDefinitions(v []*AwsEcsTaskDefinitionContainerDefinitionsDetails) *AwsEcsTaskDefinitionDetails

SetContainerDefinitions sets the ContainerDefinitions field's value.

func (*AwsEcsTaskDefinitionDetails) SetCpu added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetCpu(v string) *AwsEcsTaskDefinitionDetails

SetCpu sets the Cpu field's value.

func (*AwsEcsTaskDefinitionDetails) SetExecutionRoleArn added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetExecutionRoleArn(v string) *AwsEcsTaskDefinitionDetails

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*AwsEcsTaskDefinitionDetails) SetFamily added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetFamily(v string) *AwsEcsTaskDefinitionDetails

SetFamily sets the Family field's value.

func (*AwsEcsTaskDefinitionDetails) SetInferenceAccelerators added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetInferenceAccelerators(v []*AwsEcsTaskDefinitionInferenceAcceleratorsDetails) *AwsEcsTaskDefinitionDetails

SetInferenceAccelerators sets the InferenceAccelerators field's value.

func (*AwsEcsTaskDefinitionDetails) SetIpcMode added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetIpcMode(v string) *AwsEcsTaskDefinitionDetails

SetIpcMode sets the IpcMode field's value.

func (*AwsEcsTaskDefinitionDetails) SetMemory added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetMemory(v string) *AwsEcsTaskDefinitionDetails

SetMemory sets the Memory field's value.

func (*AwsEcsTaskDefinitionDetails) SetNetworkMode added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetNetworkMode(v string) *AwsEcsTaskDefinitionDetails

SetNetworkMode sets the NetworkMode field's value.

func (*AwsEcsTaskDefinitionDetails) SetPidMode added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetPidMode(v string) *AwsEcsTaskDefinitionDetails

SetPidMode sets the PidMode field's value.

func (*AwsEcsTaskDefinitionDetails) SetPlacementConstraints added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetPlacementConstraints(v []*AwsEcsTaskDefinitionPlacementConstraintsDetails) *AwsEcsTaskDefinitionDetails

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*AwsEcsTaskDefinitionDetails) SetProxyConfiguration added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetProxyConfiguration(v *AwsEcsTaskDefinitionProxyConfigurationDetails) *AwsEcsTaskDefinitionDetails

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*AwsEcsTaskDefinitionDetails) SetRequiresCompatibilities added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetRequiresCompatibilities(v []*string) *AwsEcsTaskDefinitionDetails

SetRequiresCompatibilities sets the RequiresCompatibilities field's value.

func (*AwsEcsTaskDefinitionDetails) SetStatus added in v1.45.23 

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

SetStatus sets the Status field's value.

func (*AwsEcsTaskDefinitionDetails) SetTaskRoleArn added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetTaskRoleArn(v string) *AwsEcsTaskDefinitionDetails

SetTaskRoleArn sets the TaskRoleArn field's value.

func (*AwsEcsTaskDefinitionDetails) SetVolumes added in v1.38.67 

func (s *AwsEcsTaskDefinitionDetails) SetVolumes(v []*AwsEcsTaskDefinitionVolumesDetails) *AwsEcsTaskDefinitionDetails

SetVolumes sets the Volumes field's value.

func (AwsEcsTaskDefinitionDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionInferenceAcceleratorsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceName(v string) *AwsEcsTaskDefinitionInferenceAcceleratorsDetails

SetDeviceName sets the DeviceName field's value.

func (*AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceType added in v1.38.67 

func (s *AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceType(v string) *AwsEcsTaskDefinitionInferenceAcceleratorsDetails

SetDeviceType sets the DeviceType field's value.

func (AwsEcsTaskDefinitionInferenceAcceleratorsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionInferenceAcceleratorsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionPlacementConstraintsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionPlacementConstraintsDetails) SetExpression(v string) *AwsEcsTaskDefinitionPlacementConstraintsDetails

SetExpression sets the Expression field's value.

func (*AwsEcsTaskDefinitionPlacementConstraintsDetails) SetType added in v1.38.67 

func (s *AwsEcsTaskDefinitionPlacementConstraintsDetails) SetType(v string) *AwsEcsTaskDefinitionPlacementConstraintsDetails

SetType sets the Type field's value.

func (AwsEcsTaskDefinitionPlacementConstraintsDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionPlacementConstraintsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionProxyConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionProxyConfigurationDetails) SetContainerName(v string) *AwsEcsTaskDefinitionProxyConfigurationDetails

SetContainerName sets the ContainerName field's value.

func (*AwsEcsTaskDefinitionProxyConfigurationDetails) SetProxyConfigurationProperties added in v1.38.67 

func (s *AwsEcsTaskDefinitionProxyConfigurationDetails) SetProxyConfigurationProperties(v []*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) *AwsEcsTaskDefinitionProxyConfigurationDetails

SetProxyConfigurationProperties sets the ProxyConfigurationProperties field's value.

func (*AwsEcsTaskDefinitionProxyConfigurationDetails) SetType added in v1.38.67 

func (s *AwsEcsTaskDefinitionProxyConfigurationDetails) SetType(v string) *AwsEcsTaskDefinitionProxyConfigurationDetails

SetType sets the Type field's value.

func (AwsEcsTaskDefinitionProxyConfigurationDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionProxyConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) SetValue added in v1.38.67 

func (s *AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) SetValue(v string) *AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDetails) SetDockerVolumeConfiguration(v *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) *AwsEcsTaskDefinitionVolumesDetails

SetDockerVolumeConfiguration sets the DockerVolumeConfiguration field's value.

func (*AwsEcsTaskDefinitionVolumesDetails) SetEfsVolumeConfiguration added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDetails) SetEfsVolumeConfiguration(v *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) *AwsEcsTaskDefinitionVolumesDetails

SetEfsVolumeConfiguration sets the EfsVolumeConfiguration field's value.

func (*AwsEcsTaskDefinitionVolumesDetails) SetHost added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDetails) SetHost(v *AwsEcsTaskDefinitionVolumesHostDetails) *AwsEcsTaskDefinitionVolumesDetails

SetHost sets the Host field's value.

func (*AwsEcsTaskDefinitionVolumesDetails) SetName added in v1.38.67 

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

SetName sets the Name field's value.

func (AwsEcsTaskDefinitionVolumesDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetAutoprovision(v bool) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails

SetAutoprovision sets the Autoprovision field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriver added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriver(v string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails

SetDriver sets the Driver field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriverOpts added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriverOpts(v map[string]*string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails

SetDriverOpts sets the DriverOpts field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetLabels added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetLabels(v map[string]*string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails

SetLabels sets the Labels field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetScope added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetScope(v string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails

SetScope sets the Scope field's value.

func (AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetAccessPointId(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails

SetAccessPointId sets the AccessPointId field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetIam added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetIam(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails

SetIam sets the Iam field's value.

func (AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetAuthorizationConfig(v *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails

SetAuthorizationConfig sets the AuthorizationConfig field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetFilesystemId added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetFilesystemId(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails

SetFilesystemId sets the FilesystemId field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetRootDirectory added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetRootDirectory(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails

SetRootDirectory sets the RootDirectory field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryption added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryption(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails

SetTransitEncryption sets the TransitEncryption field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryptionPort added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryptionPort(v int64) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails

SetTransitEncryptionPort sets the TransitEncryptionPort field's value.

func (AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesHostDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsEcsTaskDefinitionVolumesHostDetails) SetSourcePath(v string) *AwsEcsTaskDefinitionVolumesHostDetails

SetSourcePath sets the SourcePath field's value.

func (AwsEcsTaskDefinitionVolumesHostDetails) String added in v1.38.67 

func (s AwsEcsTaskDefinitionVolumesHostDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsEcsTaskDetails) SetClusterArn(v string) *AwsEcsTaskDetails

SetClusterArn sets the ClusterArn field's value.

func (*AwsEcsTaskDetails) SetContainers added in v1.44.36 

func (s *AwsEcsTaskDetails) SetContainers(v []*AwsEcsContainerDetails) *AwsEcsTaskDetails

SetContainers sets the Containers field's value.

func (*AwsEcsTaskDetails) SetCreatedAt added in v1.44.36 

func (s *AwsEcsTaskDetails) SetCreatedAt(v string) *AwsEcsTaskDetails

SetCreatedAt sets the CreatedAt field's value.

func (*AwsEcsTaskDetails) SetGroup added in v1.44.36 

func (s *AwsEcsTaskDetails) SetGroup(v string) *AwsEcsTaskDetails

SetGroup sets the Group field's value.

func (*AwsEcsTaskDetails) SetStartedAt added in v1.44.36 

func (s *AwsEcsTaskDetails) SetStartedAt(v string) *AwsEcsTaskDetails

SetStartedAt sets the StartedAt field's value.

func (*AwsEcsTaskDetails) SetStartedBy added in v1.44.36 

func (s *AwsEcsTaskDetails) SetStartedBy(v string) *AwsEcsTaskDetails

SetStartedBy sets the StartedBy field's value.

func (*AwsEcsTaskDetails) SetTaskDefinitionArn added in v1.44.36 

func (s *AwsEcsTaskDetails) SetTaskDefinitionArn(v string) *AwsEcsTaskDetails

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (*AwsEcsTaskDetails) SetVersion added in v1.44.36 

func (s *AwsEcsTaskDetails) SetVersion(v string) *AwsEcsTaskDetails

SetVersion sets the Version field's value.

func (*AwsEcsTaskDetails) SetVolumes added in v1.44.36 

func (s *AwsEcsTaskDetails) SetVolumes(v []*AwsEcsTaskVolumeDetails) *AwsEcsTaskDetails

SetVolumes sets the Volumes field's value.

func (AwsEcsTaskDetails) String added in v1.44.36 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsEcsTaskVolumeDetails) SetHost(v *AwsEcsTaskVolumeHostDetails) *AwsEcsTaskVolumeDetails

SetHost sets the Host field's value.

func (*AwsEcsTaskVolumeDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (AwsEcsTaskVolumeDetails) String added in v1.44.36 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsEcsTaskVolumeHostDetails) SetSourcePath(v string) *AwsEcsTaskVolumeHostDetails

SetSourcePath sets the SourcePath field's value.

func (AwsEcsTaskVolumeHostDetails) String added in v1.44.36 

func (s AwsEcsTaskVolumeHostDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsEfsAccessPointDetails) SetAccessPointId(v string) *AwsEfsAccessPointDetails

SetAccessPointId sets the AccessPointId field's value.

func (*AwsEfsAccessPointDetails) SetArn added in v1.44.36 

func (s *AwsEfsAccessPointDetails) SetArn(v string) *AwsEfsAccessPointDetails

SetArn sets the Arn field's value.

func (*AwsEfsAccessPointDetails) SetClientToken added in v1.44.36 

func (s *AwsEfsAccessPointDetails) SetClientToken(v string) *AwsEfsAccessPointDetails

SetClientToken sets the ClientToken field's value.

func (*AwsEfsAccessPointDetails) SetFileSystemId added in v1.44.36 

func (s *AwsEfsAccessPointDetails) SetFileSystemId(v string) *AwsEfsAccessPointDetails

SetFileSystemId sets the FileSystemId field's value.

func (*AwsEfsAccessPointDetails) SetPosixUser added in v1.44.36 

func (s *AwsEfsAccessPointDetails) SetPosixUser(v *AwsEfsAccessPointPosixUserDetails) *AwsEfsAccessPointDetails

SetPosixUser sets the PosixUser field's value.

func (*AwsEfsAccessPointDetails) SetRootDirectory added in v1.44.36 

func (s *AwsEfsAccessPointDetails) SetRootDirectory(v *AwsEfsAccessPointRootDirectoryDetails) *AwsEfsAccessPointDetails

SetRootDirectory sets the RootDirectory field's value.

func (AwsEfsAccessPointDetails) String added in v1.44.36 

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.44.36 

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.44.36 

func (s AwsEfsAccessPointPosixUserDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEfsAccessPointPosixUserDetails) SetGid(v string) *AwsEfsAccessPointPosixUserDetails

SetGid sets the Gid field's value.

func (*AwsEfsAccessPointPosixUserDetails) SetSecondaryGids added in v1.44.36 

func (s *AwsEfsAccessPointPosixUserDetails) SetSecondaryGids(v []*string) *AwsEfsAccessPointPosixUserDetails

SetSecondaryGids sets the SecondaryGids field's value.

func (*AwsEfsAccessPointPosixUserDetails) SetUid added in v1.44.36 

func (s *AwsEfsAccessPointPosixUserDetails) SetUid(v string) *AwsEfsAccessPointPosixUserDetails

SetUid sets the Uid field's value.

func (AwsEfsAccessPointPosixUserDetails) String added in v1.44.36 

func (s AwsEfsAccessPointPosixUserDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsEfsAccessPointRootDirectoryCreationInfoDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetOwnerGid(v string) *AwsEfsAccessPointRootDirectoryCreationInfoDetails

SetOwnerGid sets the OwnerGid field's value.

func (*AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetOwnerUid added in v1.44.36 

func (s *AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetOwnerUid(v string) *AwsEfsAccessPointRootDirectoryCreationInfoDetails

SetOwnerUid sets the OwnerUid field's value.

func (*AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetPermissions added in v1.44.36 

func (s *AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetPermissions(v string) *AwsEfsAccessPointRootDirectoryCreationInfoDetails

SetPermissions sets the Permissions field's value.

func (AwsEfsAccessPointRootDirectoryCreationInfoDetails) String added in v1.44.36 

func (s AwsEfsAccessPointRootDirectoryCreationInfoDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsEfsAccessPointRootDirectoryDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsEfsAccessPointRootDirectoryDetails) SetCreationInfo(v *AwsEfsAccessPointRootDirectoryCreationInfoDetails) *AwsEfsAccessPointRootDirectoryDetails

SetCreationInfo sets the CreationInfo field's value.

func (*AwsEfsAccessPointRootDirectoryDetails) SetPath added in v1.44.36 

func (s *AwsEfsAccessPointRootDirectoryDetails) SetPath(v string) *AwsEfsAccessPointRootDirectoryDetails

SetPath sets the Path field's value.

func (AwsEfsAccessPointRootDirectoryDetails) String added in v1.44.36 

func (s AwsEfsAccessPointRootDirectoryDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

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 added in v1.40.59 

func (s *AwsEksClusterDetails) SetArn(v string) *AwsEksClusterDetails

SetArn sets the Arn field's value.

func (*AwsEksClusterDetails) SetCertificateAuthorityData added in v1.40.59 

func (s *AwsEksClusterDetails) SetCertificateAuthorityData(v string) *AwsEksClusterDetails

SetCertificateAuthorityData sets the CertificateAuthorityData field's value.

func (*AwsEksClusterDetails) SetClusterStatus added in v1.40.59 

func (s *AwsEksClusterDetails) SetClusterStatus(v string) *AwsEksClusterDetails

SetClusterStatus sets the ClusterStatus field's value.

func (*AwsEksClusterDetails) SetEndpoint added in v1.40.59 

func (s *AwsEksClusterDetails) SetEndpoint(v string) *AwsEksClusterDetails

SetEndpoint sets the Endpoint field's value.

func (*AwsEksClusterDetails) SetLogging added in v1.40.59 

func (s *AwsEksClusterDetails) SetLogging(v *AwsEksClusterLoggingDetails) *AwsEksClusterDetails

SetLogging sets the Logging field's value.

func (*AwsEksClusterDetails) SetName added in v1.40.59 

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

SetName sets the Name field's value.

func (*AwsEksClusterDetails) SetResourcesVpcConfig added in v1.40.59 

func (s *AwsEksClusterDetails) SetResourcesVpcConfig(v *AwsEksClusterResourcesVpcConfigDetails) *AwsEksClusterDetails

SetResourcesVpcConfig sets the ResourcesVpcConfig field's value.

func (*AwsEksClusterDetails) SetRoleArn added in v1.40.59 

func (s *AwsEksClusterDetails) SetRoleArn(v string) *AwsEksClusterDetails

SetRoleArn sets the RoleArn field's value.

func (*AwsEksClusterDetails) SetVersion added in v1.40.59 

func (s *AwsEksClusterDetails) SetVersion(v string) *AwsEksClusterDetails

SetVersion sets the Version field's value.

func (AwsEksClusterDetails) String added in v1.40.59 

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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsEksClusterLoggingClusterLoggingDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsEksClusterLoggingClusterLoggingDetails) SetEnabled(v bool) *AwsEksClusterLoggingClusterLoggingDetails

SetEnabled sets the Enabled field's value.

func (*AwsEksClusterLoggingClusterLoggingDetails) SetTypes added in v1.40.59 

func (s *AwsEksClusterLoggingClusterLoggingDetails) SetTypes(v []*string) *AwsEksClusterLoggingClusterLoggingDetails

SetTypes sets the Types field's value.

func (AwsEksClusterLoggingClusterLoggingDetails) String added in v1.40.59 

func (s AwsEksClusterLoggingClusterLoggingDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

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 added in v1.40.59 

func (s *AwsEksClusterLoggingDetails) SetClusterLogging(v []*AwsEksClusterLoggingClusterLoggingDetails) *AwsEksClusterLoggingDetails

SetClusterLogging sets the ClusterLogging field's value.

func (AwsEksClusterLoggingDetails) String added in v1.40.59 

func (s AwsEksClusterLoggingDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsEksClusterResourcesVpcConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

func (s *AwsEksClusterResourcesVpcConfigDetails) SetEndpointPublicAccess(v bool) *AwsEksClusterResourcesVpcConfigDetails

SetEndpointPublicAccess sets the EndpointPublicAccess field's value.

func (*AwsEksClusterResourcesVpcConfigDetails) SetSecurityGroupIds added in v1.40.59 

func (s *AwsEksClusterResourcesVpcConfigDetails) SetSecurityGroupIds(v []*string) *AwsEksClusterResourcesVpcConfigDetails

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsEksClusterResourcesVpcConfigDetails) SetSubnetIds added in v1.40.59 

func (s *AwsEksClusterResourcesVpcConfigDetails) SetSubnetIds(v []*string) *AwsEksClusterResourcesVpcConfigDetails

SetSubnetIds sets the SubnetIds field's value.

func (AwsEksClusterResourcesVpcConfigDetails) String added in v1.40.59 

func (s AwsEksClusterResourcesVpcConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetApplicationName(v string) *AwsElasticBeanstalkEnvironmentDetails

SetApplicationName sets the ApplicationName field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetCname added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetCname(v string) *AwsElasticBeanstalkEnvironmentDetails

SetCname sets the Cname field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetDateCreated added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetDateCreated(v string) *AwsElasticBeanstalkEnvironmentDetails

SetDateCreated sets the DateCreated field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetDateUpdated added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetDateUpdated(v string) *AwsElasticBeanstalkEnvironmentDetails

SetDateUpdated sets the DateUpdated field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetDescription added in v1.38.31 

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

SetDescription sets the Description field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEndpointUrl added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetEndpointUrl(v string) *AwsElasticBeanstalkEnvironmentDetails

SetEndpointUrl sets the EndpointUrl field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentArn added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentArn(v string) *AwsElasticBeanstalkEnvironmentDetails

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentId added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentId(v string) *AwsElasticBeanstalkEnvironmentDetails

SetEnvironmentId sets the EnvironmentId field's value. 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentLinks(v []*AwsElasticBeanstalkEnvironmentEnvironmentLink) *AwsElasticBeanstalkEnvironmentDetails

SetEnvironmentLinks sets the EnvironmentLinks field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentName added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentName(v string) *AwsElasticBeanstalkEnvironmentDetails

SetEnvironmentName sets the EnvironmentName field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetOptionSettings added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetOptionSettings(v []*AwsElasticBeanstalkEnvironmentOptionSetting) *AwsElasticBeanstalkEnvironmentDetails

SetOptionSettings sets the OptionSettings field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetPlatformArn added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetPlatformArn(v string) *AwsElasticBeanstalkEnvironmentDetails

SetPlatformArn sets the PlatformArn field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetSolutionStackName added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetSolutionStackName(v string) *AwsElasticBeanstalkEnvironmentDetails

SetSolutionStackName sets the SolutionStackName field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetStatus added in v1.38.31 

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

SetStatus sets the Status field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetTier added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetTier(v *AwsElasticBeanstalkEnvironmentTier) *AwsElasticBeanstalkEnvironmentDetails

SetTier sets the Tier field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetVersionLabel added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentDetails) SetVersionLabel(v string) *AwsElasticBeanstalkEnvironmentDetails

SetVersionLabel sets the VersionLabel field's value.

func (AwsElasticBeanstalkEnvironmentDetails) String added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentEnvironmentLink) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentEnvironmentLink) SetEnvironmentName(v string) *AwsElasticBeanstalkEnvironmentEnvironmentLink

SetEnvironmentName sets the EnvironmentName field's value.

func (*AwsElasticBeanstalkEnvironmentEnvironmentLink) SetLinkName added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentEnvironmentLink) SetLinkName(v string) *AwsElasticBeanstalkEnvironmentEnvironmentLink

SetLinkName sets the LinkName field's value.

func (AwsElasticBeanstalkEnvironmentEnvironmentLink) String added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentEnvironmentLink) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentOptionSetting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetNamespace(v string) *AwsElasticBeanstalkEnvironmentOptionSetting

SetNamespace sets the Namespace field's value.

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetOptionName added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetOptionName(v string) *AwsElasticBeanstalkEnvironmentOptionSetting

SetOptionName sets the OptionName field's value.

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetResourceName added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetResourceName(v string) *AwsElasticBeanstalkEnvironmentOptionSetting

SetResourceName sets the ResourceName field's value.

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetValue added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetValue(v string) *AwsElasticBeanstalkEnvironmentOptionSetting

SetValue sets the Value field's value.

func (AwsElasticBeanstalkEnvironmentOptionSetting) String added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentOptionSetting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentTier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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

SetName sets the Name field's value.

func (*AwsElasticBeanstalkEnvironmentTier) SetType added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentTier) SetType(v string) *AwsElasticBeanstalkEnvironmentTier

SetType sets the Type field's value.

func (*AwsElasticBeanstalkEnvironmentTier) SetVersion added in v1.38.31 

func (s *AwsElasticBeanstalkEnvironmentTier) SetVersion(v string) *AwsElasticBeanstalkEnvironmentTier

SetVersion sets the Version field's value.

func (AwsElasticBeanstalkEnvironmentTier) String added in v1.38.31 

func (s AwsElasticBeanstalkEnvironmentTier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsElasticsearchDomainDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetAccessPolicies(v string) *AwsElasticsearchDomainDetails

SetAccessPolicies sets the AccessPolicies field's value.

func (*AwsElasticsearchDomainDetails) SetDomainEndpointOptions added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetDomainEndpointOptions(v *AwsElasticsearchDomainDomainEndpointOptions) *AwsElasticsearchDomainDetails

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*AwsElasticsearchDomainDetails) SetDomainId added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetDomainId(v string) *AwsElasticsearchDomainDetails

SetDomainId sets the DomainId field's value.

func (*AwsElasticsearchDomainDetails) SetDomainName added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetDomainName(v string) *AwsElasticsearchDomainDetails

SetDomainName sets the DomainName field's value.

func (*AwsElasticsearchDomainDetails) SetElasticsearchClusterConfig added in v1.40.7 

func (s *AwsElasticsearchDomainDetails) SetElasticsearchClusterConfig(v *AwsElasticsearchDomainElasticsearchClusterConfigDetails) *AwsElasticsearchDomainDetails

SetElasticsearchClusterConfig sets the ElasticsearchClusterConfig field's value.

func (*AwsElasticsearchDomainDetails) SetElasticsearchVersion added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetElasticsearchVersion(v string) *AwsElasticsearchDomainDetails

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*AwsElasticsearchDomainDetails) SetEncryptionAtRestOptions added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetEncryptionAtRestOptions(v *AwsElasticsearchDomainEncryptionAtRestOptions) *AwsElasticsearchDomainDetails

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*AwsElasticsearchDomainDetails) SetEndpoint added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetEndpoint(v string) *AwsElasticsearchDomainDetails

SetEndpoint sets the Endpoint field's value.

func (*AwsElasticsearchDomainDetails) SetEndpoints added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetEndpoints(v map[string]*string) *AwsElasticsearchDomainDetails

SetEndpoints sets the Endpoints field's value.

func (*AwsElasticsearchDomainDetails) SetLogPublishingOptions added in v1.38.67 

func (s *AwsElasticsearchDomainDetails) SetLogPublishingOptions(v *AwsElasticsearchDomainLogPublishingOptions) *AwsElasticsearchDomainDetails

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*AwsElasticsearchDomainDetails) SetNodeToNodeEncryptionOptions added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetNodeToNodeEncryptionOptions(v *AwsElasticsearchDomainNodeToNodeEncryptionOptions) *AwsElasticsearchDomainDetails

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*AwsElasticsearchDomainDetails) SetServiceSoftwareOptions added in v1.38.67 

func (s *AwsElasticsearchDomainDetails) SetServiceSoftwareOptions(v *AwsElasticsearchDomainServiceSoftwareOptions) *AwsElasticsearchDomainDetails

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*AwsElasticsearchDomainDetails) SetVPCOptions added in v1.28.11 

func (s *AwsElasticsearchDomainDetails) SetVPCOptions(v *AwsElasticsearchDomainVPCOptions) *AwsElasticsearchDomainDetails

SetVPCOptions sets the VPCOptions field's value.

func (AwsElasticsearchDomainDetails) String added in v1.28.11 

func (s AwsElasticsearchDomainDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsElasticsearchDomainDomainEndpointOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsElasticsearchDomainDomainEndpointOptions) SetEnforceHTTPS(v bool) *AwsElasticsearchDomainDomainEndpointOptions

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*AwsElasticsearchDomainDomainEndpointOptions) SetTLSSecurityPolicy added in v1.28.11 

func (s *AwsElasticsearchDomainDomainEndpointOptions) SetTLSSecurityPolicy(v string) *AwsElasticsearchDomainDomainEndpointOptions

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (AwsElasticsearchDomainDomainEndpointOptions) String added in v1.28.11 

func (s AwsElasticsearchDomainDomainEndpointOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsElasticsearchDomainElasticsearchClusterConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterCount(v int64) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterEnabled added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterEnabled(v bool) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterType added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterType(v string) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetInstanceCount added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetInstanceCount(v int64) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetInstanceCount sets the InstanceCount field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetInstanceType added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetInstanceType(v string) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetInstanceType sets the InstanceType field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetZoneAwarenessConfig added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetZoneAwarenessConfig(v *AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetZoneAwarenessEnabled added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetZoneAwarenessEnabled(v bool) *AwsElasticsearchDomainElasticsearchClusterConfigDetails

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (AwsElasticsearchDomainElasticsearchClusterConfigDetails) String added in v1.40.7 

func (s AwsElasticsearchDomainElasticsearchClusterConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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 added in v1.40.7 

func (s AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) SetAvailabilityZoneCount(v int64) *AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) String added in v1.40.7 

func (s AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsElasticsearchDomainEncryptionAtRestOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsElasticsearchDomainEncryptionAtRestOptions) SetEnabled(v bool) *AwsElasticsearchDomainEncryptionAtRestOptions

SetEnabled sets the Enabled field's value.

func (*AwsElasticsearchDomainEncryptionAtRestOptions) SetKmsKeyId added in v1.28.11 

func (s *AwsElasticsearchDomainEncryptionAtRestOptions) SetKmsKeyId(v string) *AwsElasticsearchDomainEncryptionAtRestOptions

SetKmsKeyId sets the KmsKeyId field's value.

func (AwsElasticsearchDomainEncryptionAtRestOptions) String added in v1.28.11 

func (s AwsElasticsearchDomainEncryptionAtRestOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsElasticsearchDomainLogPublishingOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsElasticsearchDomainLogPublishingOptions) SetAuditLogs(v *AwsElasticsearchDomainLogPublishingOptionsLogConfig) *AwsElasticsearchDomainLogPublishingOptions

SetAuditLogs sets the AuditLogs field's value.

func (*AwsElasticsearchDomainLogPublishingOptions) SetIndexSlowLogs added in v1.38.67 

func (s *AwsElasticsearchDomainLogPublishingOptions) SetIndexSlowLogs(v *AwsElasticsearchDomainLogPublishingOptionsLogConfig) *AwsElasticsearchDomainLogPublishingOptions

SetIndexSlowLogs sets the IndexSlowLogs field's value.

func (*AwsElasticsearchDomainLogPublishingOptions) SetSearchSlowLogs added in v1.38.67 

func (s *AwsElasticsearchDomainLogPublishingOptions) SetSearchSlowLogs(v *AwsElasticsearchDomainLogPublishingOptionsLogConfig) *AwsElasticsearchDomainLogPublishingOptions

SetSearchSlowLogs sets the SearchSlowLogs field's value.

func (AwsElasticsearchDomainLogPublishingOptions) String added in v1.38.67 

func (s AwsElasticsearchDomainLogPublishingOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsElasticsearchDomainLogPublishingOptionsLogConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetCloudWatchLogsLogGroupArn(v string) *AwsElasticsearchDomainLogPublishingOptionsLogConfig

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetEnabled added in v1.38.67 

func (s *AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetEnabled(v bool) *AwsElasticsearchDomainLogPublishingOptionsLogConfig

SetEnabled sets the Enabled field's value.

func (AwsElasticsearchDomainLogPublishingOptionsLogConfig) String added in v1.38.67 

func (s AwsElasticsearchDomainLogPublishingOptionsLogConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsElasticsearchDomainNodeToNodeEncryptionOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsElasticsearchDomainNodeToNodeEncryptionOptions) SetEnabled(v bool) *AwsElasticsearchDomainNodeToNodeEncryptionOptions

SetEnabled sets the Enabled field's value.

func (AwsElasticsearchDomainNodeToNodeEncryptionOptions) String added in v1.28.11 

func (s AwsElasticsearchDomainNodeToNodeEncryptionOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsElasticsearchDomainServiceSoftwareOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetAutomatedUpdateDate(v string) *AwsElasticsearchDomainServiceSoftwareOptions

SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetCancellable added in v1.38.67 

func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetCancellable(v bool) *AwsElasticsearchDomainServiceSoftwareOptions

SetCancellable sets the Cancellable field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetCurrentVersion added in v1.38.67 

func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetCurrentVersion(v string) *AwsElasticsearchDomainServiceSoftwareOptions

SetCurrentVersion sets the CurrentVersion field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetDescription added in v1.38.67 

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

SetDescription sets the Description field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetNewVersion added in v1.38.67 

func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetNewVersion(v string) *AwsElasticsearchDomainServiceSoftwareOptions

SetNewVersion sets the NewVersion field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateAvailable added in v1.38.67 

func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateAvailable(v bool) *AwsElasticsearchDomainServiceSoftwareOptions

SetUpdateAvailable sets the UpdateAvailable field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateStatus added in v1.38.67 

func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateStatus(v string) *AwsElasticsearchDomainServiceSoftwareOptions

SetUpdateStatus sets the UpdateStatus field's value.

func (AwsElasticsearchDomainServiceSoftwareOptions) String added in v1.38.67 

func (s AwsElasticsearchDomainServiceSoftwareOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsElasticsearchDomainVPCOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsElasticsearchDomainVPCOptions) SetAvailabilityZones(v []*string) *AwsElasticsearchDomainVPCOptions

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsElasticsearchDomainVPCOptions) SetSecurityGroupIds added in v1.28.11 

func (s *AwsElasticsearchDomainVPCOptions) SetSecurityGroupIds(v []*string) *AwsElasticsearchDomainVPCOptions

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsElasticsearchDomainVPCOptions) SetSubnetIds added in v1.28.11 

func (s *AwsElasticsearchDomainVPCOptions) SetSubnetIds(v []*string) *AwsElasticsearchDomainVPCOptions

SetSubnetIds sets the SubnetIds field's value.

func (*AwsElasticsearchDomainVPCOptions) SetVPCId added in v1.28.11 

func (s *AwsElasticsearchDomainVPCOptions) SetVPCId(v string) *AwsElasticsearchDomainVPCOptions

SetVPCId sets the VPCId field's value.

func (AwsElasticsearchDomainVPCOptions) String added in v1.28.11 

func (s AwsElasticsearchDomainVPCOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbAppCookieStickinessPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbAppCookieStickinessPolicy) SetCookieName(v string) *AwsElbAppCookieStickinessPolicy

SetCookieName sets the CookieName field's value.

func (*AwsElbAppCookieStickinessPolicy) SetPolicyName added in v1.35.0 

func (s *AwsElbAppCookieStickinessPolicy) SetPolicyName(v string) *AwsElbAppCookieStickinessPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsElbAppCookieStickinessPolicy) String added in v1.35.0 

func (s AwsElbAppCookieStickinessPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLbCookieStickinessPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLbCookieStickinessPolicy) SetCookieExpirationPeriod(v int64) *AwsElbLbCookieStickinessPolicy

SetCookieExpirationPeriod sets the CookieExpirationPeriod field's value.

func (*AwsElbLbCookieStickinessPolicy) SetPolicyName added in v1.35.0 

func (s *AwsElbLbCookieStickinessPolicy) SetPolicyName(v string) *AwsElbLbCookieStickinessPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsElbLbCookieStickinessPolicy) String added in v1.35.0 

func (s AwsElbLbCookieStickinessPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsElbLoadBalancerAccessLog) SetEmitInterval(v int64) *AwsElbLoadBalancerAccessLog

SetEmitInterval sets the EmitInterval field's value.

func (*AwsElbLoadBalancerAccessLog) SetEnabled added in v1.35.0 

func (s *AwsElbLoadBalancerAccessLog) SetEnabled(v bool) *AwsElbLoadBalancerAccessLog

SetEnabled sets the Enabled field's value.

func (*AwsElbLoadBalancerAccessLog) SetS3BucketName added in v1.35.0 

func (s *AwsElbLoadBalancerAccessLog) SetS3BucketName(v string) *AwsElbLoadBalancerAccessLog

SetS3BucketName sets the S3BucketName field's value.

func (*AwsElbLoadBalancerAccessLog) SetS3BucketPrefix added in v1.35.0 

func (s *AwsElbLoadBalancerAccessLog) SetS3BucketPrefix(v string) *AwsElbLoadBalancerAccessLog

SetS3BucketPrefix sets the S3BucketPrefix field's value.

func (AwsElbLoadBalancerAccessLog) String added in v1.35.0 

func (s AwsElbLoadBalancerAccessLog) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

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.43.33 

func (s AwsElbLoadBalancerAdditionalAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

func (s *AwsElbLoadBalancerAdditionalAttribute) SetKey(v string) *AwsElbLoadBalancerAdditionalAttribute

SetKey sets the Key field's value.

func (*AwsElbLoadBalancerAdditionalAttribute) SetValue added in v1.43.33 

func (s *AwsElbLoadBalancerAdditionalAttribute) SetValue(v string) *AwsElbLoadBalancerAdditionalAttribute

SetValue sets the Value field's value.

func (AwsElbLoadBalancerAdditionalAttribute) String added in v1.43.33 

func (s AwsElbLoadBalancerAdditionalAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsElbLoadBalancerAttributes) SetAccessLog(v *AwsElbLoadBalancerAccessLog) *AwsElbLoadBalancerAttributes

SetAccessLog sets the AccessLog field's value.

func (*AwsElbLoadBalancerAttributes) SetAdditionalAttributes added in v1.43.33 

func (s *AwsElbLoadBalancerAttributes) SetAdditionalAttributes(v []*AwsElbLoadBalancerAdditionalAttribute) *AwsElbLoadBalancerAttributes

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*AwsElbLoadBalancerAttributes) SetConnectionDraining added in v1.35.0 

func (s *AwsElbLoadBalancerAttributes) SetConnectionDraining(v *AwsElbLoadBalancerConnectionDraining) *AwsElbLoadBalancerAttributes

SetConnectionDraining sets the ConnectionDraining field's value.

func (*AwsElbLoadBalancerAttributes) SetConnectionSettings added in v1.35.0 

func (s *AwsElbLoadBalancerAttributes) SetConnectionSettings(v *AwsElbLoadBalancerConnectionSettings) *AwsElbLoadBalancerAttributes

SetConnectionSettings sets the ConnectionSettings field's value.

func (*AwsElbLoadBalancerAttributes) SetCrossZoneLoadBalancing added in v1.35.0 

func (s *AwsElbLoadBalancerAttributes) SetCrossZoneLoadBalancing(v *AwsElbLoadBalancerCrossZoneLoadBalancing) *AwsElbLoadBalancerAttributes

SetCrossZoneLoadBalancing sets the CrossZoneLoadBalancing field's value.

func (AwsElbLoadBalancerAttributes) String added in v1.35.0 

func (s AwsElbLoadBalancerAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerBackendServerDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerBackendServerDescription) SetInstancePort(v int64) *AwsElbLoadBalancerBackendServerDescription

SetInstancePort sets the InstancePort field's value.

func (*AwsElbLoadBalancerBackendServerDescription) SetPolicyNames added in v1.35.0 

func (s *AwsElbLoadBalancerBackendServerDescription) SetPolicyNames(v []*string) *AwsElbLoadBalancerBackendServerDescription

SetPolicyNames sets the PolicyNames field's value.

func (AwsElbLoadBalancerBackendServerDescription) String added in v1.35.0 

func (s AwsElbLoadBalancerBackendServerDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerConnectionDraining) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerConnectionDraining) SetEnabled(v bool) *AwsElbLoadBalancerConnectionDraining

SetEnabled sets the Enabled field's value.

func (*AwsElbLoadBalancerConnectionDraining) SetTimeout added in v1.35.0 

func (s *AwsElbLoadBalancerConnectionDraining) SetTimeout(v int64) *AwsElbLoadBalancerConnectionDraining

SetTimeout sets the Timeout field's value.

func (AwsElbLoadBalancerConnectionDraining) String added in v1.35.0 

func (s AwsElbLoadBalancerConnectionDraining) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerConnectionSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerConnectionSettings) SetIdleTimeout(v int64) *AwsElbLoadBalancerConnectionSettings

SetIdleTimeout sets the IdleTimeout field's value.

func (AwsElbLoadBalancerConnectionSettings) String added in v1.35.0 

func (s AwsElbLoadBalancerConnectionSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerCrossZoneLoadBalancing) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerCrossZoneLoadBalancing) SetEnabled(v bool) *AwsElbLoadBalancerCrossZoneLoadBalancing

SetEnabled sets the Enabled field's value.

func (AwsElbLoadBalancerCrossZoneLoadBalancing) String added in v1.35.0 

func (s AwsElbLoadBalancerCrossZoneLoadBalancing) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetAvailabilityZones(v []*string) *AwsElbLoadBalancerDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsElbLoadBalancerDetails) SetBackendServerDescriptions added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetBackendServerDescriptions(v []*AwsElbLoadBalancerBackendServerDescription) *AwsElbLoadBalancerDetails

SetBackendServerDescriptions sets the BackendServerDescriptions field's value.

func (*AwsElbLoadBalancerDetails) SetCanonicalHostedZoneName added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneName(v string) *AwsElbLoadBalancerDetails

SetCanonicalHostedZoneName sets the CanonicalHostedZoneName field's value.

func (*AwsElbLoadBalancerDetails) SetCanonicalHostedZoneNameID added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneNameID(v string) *AwsElbLoadBalancerDetails

SetCanonicalHostedZoneNameID sets the CanonicalHostedZoneNameID field's value.

func (*AwsElbLoadBalancerDetails) SetCreatedTime added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetCreatedTime(v string) *AwsElbLoadBalancerDetails

SetCreatedTime sets the CreatedTime field's value.

func (*AwsElbLoadBalancerDetails) SetDnsName added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetDnsName(v string) *AwsElbLoadBalancerDetails

SetDnsName sets the DnsName field's value.

func (*AwsElbLoadBalancerDetails) SetHealthCheck added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetHealthCheck(v *AwsElbLoadBalancerHealthCheck) *AwsElbLoadBalancerDetails

SetHealthCheck sets the HealthCheck field's value.

func (*AwsElbLoadBalancerDetails) SetInstances added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetInstances(v []*AwsElbLoadBalancerInstance) *AwsElbLoadBalancerDetails

SetInstances sets the Instances field's value.

func (*AwsElbLoadBalancerDetails) SetListenerDescriptions added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetListenerDescriptions(v []*AwsElbLoadBalancerListenerDescription) *AwsElbLoadBalancerDetails

SetListenerDescriptions sets the ListenerDescriptions field's value.

func (*AwsElbLoadBalancerDetails) SetLoadBalancerAttributes added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetLoadBalancerAttributes(v *AwsElbLoadBalancerAttributes) *AwsElbLoadBalancerDetails

SetLoadBalancerAttributes sets the LoadBalancerAttributes field's value.

func (*AwsElbLoadBalancerDetails) SetLoadBalancerName added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetLoadBalancerName(v string) *AwsElbLoadBalancerDetails

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*AwsElbLoadBalancerDetails) SetPolicies added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetPolicies(v *AwsElbLoadBalancerPolicies) *AwsElbLoadBalancerDetails

SetPolicies sets the Policies field's value.

func (*AwsElbLoadBalancerDetails) SetScheme added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetScheme(v string) *AwsElbLoadBalancerDetails

SetScheme sets the Scheme field's value.

func (*AwsElbLoadBalancerDetails) SetSecurityGroups added in v1.35.0 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsElbLoadBalancerDetails) SetSourceSecurityGroup added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetSourceSecurityGroup(v *AwsElbLoadBalancerSourceSecurityGroup) *AwsElbLoadBalancerDetails

SetSourceSecurityGroup sets the SourceSecurityGroup field's value.

func (*AwsElbLoadBalancerDetails) SetSubnets added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetSubnets(v []*string) *AwsElbLoadBalancerDetails

SetSubnets sets the Subnets field's value.

func (*AwsElbLoadBalancerDetails) SetVpcId added in v1.35.0 

func (s *AwsElbLoadBalancerDetails) SetVpcId(v string) *AwsElbLoadBalancerDetails

SetVpcId sets the VpcId field's value.

func (AwsElbLoadBalancerDetails) String added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerHealthCheck) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerHealthCheck) SetHealthyThreshold(v int64) *AwsElbLoadBalancerHealthCheck

SetHealthyThreshold sets the HealthyThreshold field's value.

func (*AwsElbLoadBalancerHealthCheck) SetInterval added in v1.35.0 

func (s *AwsElbLoadBalancerHealthCheck) SetInterval(v int64) *AwsElbLoadBalancerHealthCheck

SetInterval sets the Interval field's value.

func (*AwsElbLoadBalancerHealthCheck) SetTarget added in v1.35.0 

func (s *AwsElbLoadBalancerHealthCheck) SetTarget(v string) *AwsElbLoadBalancerHealthCheck

SetTarget sets the Target field's value.

func (*AwsElbLoadBalancerHealthCheck) SetTimeout added in v1.35.0 

func (s *AwsElbLoadBalancerHealthCheck) SetTimeout(v int64) *AwsElbLoadBalancerHealthCheck

SetTimeout sets the Timeout field's value.

func (*AwsElbLoadBalancerHealthCheck) SetUnhealthyThreshold added in v1.35.0 

func (s *AwsElbLoadBalancerHealthCheck) SetUnhealthyThreshold(v int64) *AwsElbLoadBalancerHealthCheck

SetUnhealthyThreshold sets the UnhealthyThreshold field's value.

func (AwsElbLoadBalancerHealthCheck) String added in v1.35.0 

func (s AwsElbLoadBalancerHealthCheck) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsElbLoadBalancerInstance) SetInstanceId(v string) *AwsElbLoadBalancerInstance

SetInstanceId sets the InstanceId field's value.

func (AwsElbLoadBalancerInstance) String added in v1.35.0 

func (s AwsElbLoadBalancerInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsElbLoadBalancerListener) SetInstancePort(v int64) *AwsElbLoadBalancerListener

SetInstancePort sets the InstancePort field's value.

func (*AwsElbLoadBalancerListener) SetInstanceProtocol added in v1.35.0 

func (s *AwsElbLoadBalancerListener) SetInstanceProtocol(v string) *AwsElbLoadBalancerListener

SetInstanceProtocol sets the InstanceProtocol field's value.

func (*AwsElbLoadBalancerListener) SetLoadBalancerPort added in v1.35.0 

func (s *AwsElbLoadBalancerListener) SetLoadBalancerPort(v int64) *AwsElbLoadBalancerListener

SetLoadBalancerPort sets the LoadBalancerPort field's value.

func (*AwsElbLoadBalancerListener) SetProtocol added in v1.35.0 

func (s *AwsElbLoadBalancerListener) SetProtocol(v string) *AwsElbLoadBalancerListener

SetProtocol sets the Protocol field's value.

func (*AwsElbLoadBalancerListener) SetSslCertificateId added in v1.35.0 

func (s *AwsElbLoadBalancerListener) SetSslCertificateId(v string) *AwsElbLoadBalancerListener

SetSslCertificateId sets the SslCertificateId field's value.

func (AwsElbLoadBalancerListener) String added in v1.35.0 

func (s AwsElbLoadBalancerListener) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerListenerDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerListenerDescription) SetListener(v *AwsElbLoadBalancerListener) *AwsElbLoadBalancerListenerDescription

SetListener sets the Listener field's value.

func (*AwsElbLoadBalancerListenerDescription) SetPolicyNames added in v1.35.0 

func (s *AwsElbLoadBalancerListenerDescription) SetPolicyNames(v []*string) *AwsElbLoadBalancerListenerDescription

SetPolicyNames sets the PolicyNames field's value.

func (AwsElbLoadBalancerListenerDescription) String added in v1.35.0 

func (s AwsElbLoadBalancerListenerDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsElbLoadBalancerPolicies) SetAppCookieStickinessPolicies(v []*AwsElbAppCookieStickinessPolicy) *AwsElbLoadBalancerPolicies

SetAppCookieStickinessPolicies sets the AppCookieStickinessPolicies field's value.

func (*AwsElbLoadBalancerPolicies) SetLbCookieStickinessPolicies added in v1.35.0 

func (s *AwsElbLoadBalancerPolicies) SetLbCookieStickinessPolicies(v []*AwsElbLbCookieStickinessPolicy) *AwsElbLoadBalancerPolicies

SetLbCookieStickinessPolicies sets the LbCookieStickinessPolicies field's value.

func (*AwsElbLoadBalancerPolicies) SetOtherPolicies added in v1.35.0 

func (s *AwsElbLoadBalancerPolicies) SetOtherPolicies(v []*string) *AwsElbLoadBalancerPolicies

SetOtherPolicies sets the OtherPolicies field's value.

func (AwsElbLoadBalancerPolicies) String added in v1.35.0 

func (s AwsElbLoadBalancerPolicies) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsElbLoadBalancerSourceSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsElbLoadBalancerSourceSecurityGroup) SetGroupName(v string) *AwsElbLoadBalancerSourceSecurityGroup

SetGroupName sets the GroupName field's value.

func (*AwsElbLoadBalancerSourceSecurityGroup) SetOwnerAlias added in v1.35.0 

func (s *AwsElbLoadBalancerSourceSecurityGroup) SetOwnerAlias(v string) *AwsElbLoadBalancerSourceSecurityGroup

SetOwnerAlias sets the OwnerAlias field's value.

func (AwsElbLoadBalancerSourceSecurityGroup) String added in v1.35.0 

func (s AwsElbLoadBalancerSourceSecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsElbv2LoadBalancerAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsElbv2LoadBalancerAttribute) SetKey(v string) *AwsElbv2LoadBalancerAttribute

SetKey sets the Key field's value.

func (*AwsElbv2LoadBalancerAttribute) SetValue added in v1.40.59 

func (s *AwsElbv2LoadBalancerAttribute) SetValue(v string) *AwsElbv2LoadBalancerAttribute

SetValue sets the Value field's value.

func (AwsElbv2LoadBalancerAttribute) String added in v1.40.59 

func (s AwsElbv2LoadBalancerAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetAvailabilityZones(v []*AvailabilityZone) *AwsElbv2LoadBalancerDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsElbv2LoadBalancerDetails) SetCanonicalHostedZoneId added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetCanonicalHostedZoneId(v string) *AwsElbv2LoadBalancerDetails

SetCanonicalHostedZoneId sets the CanonicalHostedZoneId field's value.

func (*AwsElbv2LoadBalancerDetails) SetCreatedTime added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetCreatedTime(v string) *AwsElbv2LoadBalancerDetails

SetCreatedTime sets the CreatedTime field's value.

func (*AwsElbv2LoadBalancerDetails) SetDNSName added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetDNSName(v string) *AwsElbv2LoadBalancerDetails

SetDNSName sets the DNSName field's value.

func (*AwsElbv2LoadBalancerDetails) SetIpAddressType added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetIpAddressType(v string) *AwsElbv2LoadBalancerDetails

SetIpAddressType sets the IpAddressType field's value.

func (*AwsElbv2LoadBalancerDetails) SetLoadBalancerAttributes added in v1.40.59 

func (s *AwsElbv2LoadBalancerDetails) SetLoadBalancerAttributes(v []*AwsElbv2LoadBalancerAttribute) *AwsElbv2LoadBalancerDetails

SetLoadBalancerAttributes sets the LoadBalancerAttributes field's value.

func (*AwsElbv2LoadBalancerDetails) SetScheme added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetScheme(v string) *AwsElbv2LoadBalancerDetails

SetScheme sets the Scheme field's value.

func (*AwsElbv2LoadBalancerDetails) SetSecurityGroups added in v1.26.7 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsElbv2LoadBalancerDetails) SetState added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetState(v *LoadBalancerState) *AwsElbv2LoadBalancerDetails

SetState sets the State field's value.

func (*AwsElbv2LoadBalancerDetails) SetType added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetType(v string) *AwsElbv2LoadBalancerDetails

SetType sets the Type field's value.

func (*AwsElbv2LoadBalancerDetails) SetVpcId added in v1.26.7 

func (s *AwsElbv2LoadBalancerDetails) SetVpcId(v string) *AwsElbv2LoadBalancerDetails

SetVpcId sets the VpcId field's value.

func (AwsElbv2LoadBalancerDetails) String added in v1.26.7 

func (s AwsElbv2LoadBalancerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsEventSchemasRegistryDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetDescription sets the Description field's value.

func (*AwsEventSchemasRegistryDetails) SetRegistryArn added in v1.44.272 

func (s *AwsEventSchemasRegistryDetails) SetRegistryArn(v string) *AwsEventSchemasRegistryDetails

SetRegistryArn sets the RegistryArn field's value.

func (*AwsEventSchemasRegistryDetails) SetRegistryName added in v1.44.272 

func (s *AwsEventSchemasRegistryDetails) SetRegistryName(v string) *AwsEventSchemasRegistryDetails

SetRegistryName sets the RegistryName field's value.

func (AwsEventSchemasRegistryDetails) String added in v1.44.272 

func (s AwsEventSchemasRegistryDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointDetails added in v1.45.23 

type AwsEventsEndpointDetails struct {

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

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

	// The URL subdomain of the endpoint. For example, if EndpointUrl is https://abcde.veo.endpoints.event.amazonaws.com,
	// then the EndpointId is abcde.veo.
	EndpointId *string `type:"string"`

	// The URL of the endpoint.
	EndpointUrl *string `type:"string"`

	// The event buses being used by the endpoint.
	EventBuses []*AwsEventsEndpointEventBusesDetails `type:"list"`

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

	// Whether event replication was enabled or disabled for this endpoint. The
	// default state is ENABLED, which means you must supply a RoleArn. If you don't
	// have a RoleArn or you don't want event replication enabled, set the state
	// to DISABLED.
	ReplicationConfig *AwsEventsEndpointReplicationConfigDetails `type:"structure"`

	// The ARN of the role used by event replication for the endpoint.
	RoleArn *string `type:"string"`

	// The routing configuration of the endpoint.
	RoutingConfig *AwsEventsEndpointRoutingConfigDetails `type:"structure"`

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

	// The reason the endpoint is in its current state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.

func (AwsEventsEndpointDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointDetails) SetArn added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetArn(v string) *AwsEventsEndpointDetails

SetArn sets the Arn field's value.

func (*AwsEventsEndpointDetails) SetDescription added in v1.45.23 

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

SetDescription sets the Description field's value.

func (*AwsEventsEndpointDetails) SetEndpointId added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetEndpointId(v string) *AwsEventsEndpointDetails

SetEndpointId sets the EndpointId field's value.

func (*AwsEventsEndpointDetails) SetEndpointUrl added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetEndpointUrl(v string) *AwsEventsEndpointDetails

SetEndpointUrl sets the EndpointUrl field's value.

func (*AwsEventsEndpointDetails) SetEventBuses added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetEventBuses(v []*AwsEventsEndpointEventBusesDetails) *AwsEventsEndpointDetails

SetEventBuses sets the EventBuses field's value.

func (*AwsEventsEndpointDetails) SetName added in v1.45.23 

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

SetName sets the Name field's value.

func (*AwsEventsEndpointDetails) SetReplicationConfig added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetReplicationConfig(v *AwsEventsEndpointReplicationConfigDetails) *AwsEventsEndpointDetails

SetReplicationConfig sets the ReplicationConfig field's value.

func (*AwsEventsEndpointDetails) SetRoleArn added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetRoleArn(v string) *AwsEventsEndpointDetails

SetRoleArn sets the RoleArn field's value.

func (*AwsEventsEndpointDetails) SetRoutingConfig added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetRoutingConfig(v *AwsEventsEndpointRoutingConfigDetails) *AwsEventsEndpointDetails

SetRoutingConfig sets the RoutingConfig field's value.

func (*AwsEventsEndpointDetails) SetState added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetState(v string) *AwsEventsEndpointDetails

SetState sets the State field's value.

func (*AwsEventsEndpointDetails) SetStateReason added in v1.45.23 

func (s *AwsEventsEndpointDetails) SetStateReason(v string) *AwsEventsEndpointDetails

SetStateReason sets the StateReason field's value.

func (AwsEventsEndpointDetails) String added in v1.45.23 

func (s AwsEventsEndpointDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointEventBusesDetails added in v1.45.23 

type AwsEventsEndpointEventBusesDetails struct {

	// The Amazon Resource Name (ARN) of the event bus that the endpoint is associated
	// with.
	EventBusArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the Amazon EventBridge event buses that the endpoint is associated with.

func (AwsEventsEndpointEventBusesDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointEventBusesDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointEventBusesDetails) SetEventBusArn added in v1.45.23 

func (s *AwsEventsEndpointEventBusesDetails) SetEventBusArn(v string) *AwsEventsEndpointEventBusesDetails

SetEventBusArn sets the EventBusArn field's value.

func (AwsEventsEndpointEventBusesDetails) String added in v1.45.23 

func (s AwsEventsEndpointEventBusesDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointReplicationConfigDetails added in v1.45.23 

type AwsEventsEndpointReplicationConfigDetails struct {

	// The state of event replication.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

Indicates whether replication is enabled or disabled for the endpoint. If enabled, the endpoint can replicate all events to a secondary Amazon Web Services Region.

func (AwsEventsEndpointReplicationConfigDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointReplicationConfigDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointReplicationConfigDetails) SetState added in v1.45.23 

func (s *AwsEventsEndpointReplicationConfigDetails) SetState(v string) *AwsEventsEndpointReplicationConfigDetails

SetState sets the State field's value.

func (AwsEventsEndpointReplicationConfigDetails) String added in v1.45.23 

func (s AwsEventsEndpointReplicationConfigDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointRoutingConfigDetails added in v1.45.23 

type AwsEventsEndpointRoutingConfigDetails struct {

	// The failover configuration for an endpoint. This includes what triggers failover
	// and what happens when it's triggered.
	FailoverConfig *AwsEventsEndpointRoutingConfigFailoverConfigDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about the routing configuration of the endpoint.

func (AwsEventsEndpointRoutingConfigDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointRoutingConfigDetails) SetFailoverConfig added in v1.45.23 

func (s *AwsEventsEndpointRoutingConfigDetails) SetFailoverConfig(v *AwsEventsEndpointRoutingConfigFailoverConfigDetails) *AwsEventsEndpointRoutingConfigDetails

SetFailoverConfig sets the FailoverConfig field's value.

func (AwsEventsEndpointRoutingConfigDetails) String added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointRoutingConfigFailoverConfigDetails added in v1.45.23 

type AwsEventsEndpointRoutingConfigFailoverConfigDetails struct {

	// The main Region of the endpoint.
	Primary *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails `type:"structure"`

	// The Region that events are routed to when failover is triggered or event
	// replication is enabled.
	Secondary *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails `type:"structure"`
	// contains filtered or unexported fields
}

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

func (AwsEventsEndpointRoutingConfigFailoverConfigDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigFailoverConfigDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointRoutingConfigFailoverConfigDetails) SetPrimary added in v1.45.23 

func (s *AwsEventsEndpointRoutingConfigFailoverConfigDetails) SetPrimary(v *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) *AwsEventsEndpointRoutingConfigFailoverConfigDetails

SetPrimary sets the Primary field's value.

func (*AwsEventsEndpointRoutingConfigFailoverConfigDetails) SetSecondary added in v1.45.23 

func (s *AwsEventsEndpointRoutingConfigFailoverConfigDetails) SetSecondary(v *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) *AwsEventsEndpointRoutingConfigFailoverConfigDetails

SetSecondary sets the Secondary field's value.

func (AwsEventsEndpointRoutingConfigFailoverConfigDetails) String added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigFailoverConfigDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails added in v1.45.23 

type AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails struct {

	// The Amazon Resource Name (ARN) of the health check used by the endpoint to
	// determine whether failover is triggered.
	HealthCheck *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the primary Amazon Web Services Region of the endpoint.

func (AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) SetHealthCheck added in v1.45.23 

func (s *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) SetHealthCheck(v string) *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails

SetHealthCheck sets the HealthCheck field's value.

func (AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) String added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) String() string

String returns the string representation.

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

type AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails added in v1.45.23 

type AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails struct {

	// Defines the secondary Region.
	Route *string `type:"string"`
	// contains filtered or unexported fields
}

The Amazon Web Services Region that events are routed to when failover is triggered or event replication is enabled.

func (AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) GoString added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) SetRoute added in v1.45.23 

func (s *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) SetRoute(v string) *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails

SetRoute sets the Route field's value.

func (AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) String added in v1.45.23 

func (s AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) String() string

String returns the string representation.

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

type AwsEventsEventbusDetails added in v1.45.23 

type AwsEventsEventbusDetails struct {

	// The Amazon Resource Name (ARN) of the account permitted to write events to
	// the current account.
	Arn *string `type:"string"`

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

	// The policy that enables the external account to send events to your account.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about Amazon EventBridge event bus. An event bus is a router that receives events and delivers them to zero or more destinations, or targets. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

func (AwsEventsEventbusDetails) GoString added in v1.45.23 

func (s AwsEventsEventbusDetails) GoString() string

GoString returns the string representation.

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

func (*AwsEventsEventbusDetails) SetArn added in v1.45.23 

func (s *AwsEventsEventbusDetails) SetArn(v string) *AwsEventsEventbusDetails

SetArn sets the Arn field's value.

func (*AwsEventsEventbusDetails) SetName added in v1.45.23 

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

SetName sets the Name field's value.

func (*AwsEventsEventbusDetails) SetPolicy added in v1.45.23 

func (s *AwsEventsEventbusDetails) SetPolicy(v string) *AwsEventsEventbusDetails

SetPolicy sets the Policy field's value.

func (AwsEventsEventbusDetails) String added in v1.45.23 

func (s AwsEventsEventbusDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesCloudTrailDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesCloudTrailDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesCloudTrailDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsGuardDutyDetectorDataSourcesDetails) SetCloudTrail(v *AwsGuardDutyDetectorDataSourcesCloudTrailDetails) *AwsGuardDutyDetectorDataSourcesDetails

SetCloudTrail sets the CloudTrail field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetDnsLogs added in v1.44.272 

func (s *AwsGuardDutyDetectorDataSourcesDetails) SetDnsLogs(v *AwsGuardDutyDetectorDataSourcesDnsLogsDetails) *AwsGuardDutyDetectorDataSourcesDetails

SetDnsLogs sets the DnsLogs field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetFlowLogs added in v1.44.272 

func (s *AwsGuardDutyDetectorDataSourcesDetails) SetFlowLogs(v *AwsGuardDutyDetectorDataSourcesFlowLogsDetails) *AwsGuardDutyDetectorDataSourcesDetails

SetFlowLogs sets the FlowLogs field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetKubernetes added in v1.44.272 

func (s *AwsGuardDutyDetectorDataSourcesDetails) SetKubernetes(v *AwsGuardDutyDetectorDataSourcesKubernetesDetails) *AwsGuardDutyDetectorDataSourcesDetails

SetKubernetes sets the Kubernetes field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetMalwareProtection added in v1.44.272 

func (s *AwsGuardDutyDetectorDataSourcesDetails) SetMalwareProtection(v *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) *AwsGuardDutyDetectorDataSourcesDetails

SetMalwareProtection sets the MalwareProtection field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetS3Logs added in v1.44.272 

func (s *AwsGuardDutyDetectorDataSourcesDetails) SetS3Logs(v *AwsGuardDutyDetectorDataSourcesS3LogsDetails) *AwsGuardDutyDetectorDataSourcesDetails

SetS3Logs sets the S3Logs field's value.

func (AwsGuardDutyDetectorDataSourcesDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesDnsLogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesDnsLogsDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesDnsLogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesFlowLogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesFlowLogsDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesFlowLogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesKubernetesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsGuardDutyDetectorDataSourcesKubernetesDetails) SetAuditLogs(v *AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) *AwsGuardDutyDetectorDataSourcesKubernetesDetails

SetAuditLogs sets the AuditLogs field's value.

func (AwsGuardDutyDetectorDataSourcesKubernetesDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesKubernetesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) SetScanEc2InstanceWithFindings(v *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails

SetScanEc2InstanceWithFindings sets the ScanEc2InstanceWithFindings field's value.

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) SetServiceRole added in v1.44.272 

func (s *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) SetServiceRole(v string) *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails

SetServiceRole sets the ServiceRole field's value.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) SetEbsVolumes(v *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails

SetEbsVolumes sets the EbsVolumes field's value.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetReason sets the Reason field's value.

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) SetStatus added in v1.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorDataSourcesS3LogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesS3LogsDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDataSourcesS3LogsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

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.44.272 

func (s *AwsGuardDutyDetectorDetails) SetDataSources(v *AwsGuardDutyDetectorDataSourcesDetails) *AwsGuardDutyDetectorDetails

SetDataSources sets the DataSources field's value.

func (*AwsGuardDutyDetectorDetails) SetFeatures added in v1.44.272 

func (s *AwsGuardDutyDetectorDetails) SetFeatures(v []*AwsGuardDutyDetectorFeaturesDetails) *AwsGuardDutyDetectorDetails

SetFeatures sets the Features field's value.

func (*AwsGuardDutyDetectorDetails) SetFindingPublishingFrequency added in v1.44.272 

func (s *AwsGuardDutyDetectorDetails) SetFindingPublishingFrequency(v string) *AwsGuardDutyDetectorDetails

SetFindingPublishingFrequency sets the FindingPublishingFrequency field's value.

func (*AwsGuardDutyDetectorDetails) SetServiceRole added in v1.44.272 

func (s *AwsGuardDutyDetectorDetails) SetServiceRole(v string) *AwsGuardDutyDetectorDetails

SetServiceRole sets the ServiceRole field's value.

func (*AwsGuardDutyDetectorDetails) SetStatus added in v1.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsGuardDutyDetectorFeaturesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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

SetName sets the Name field's value.

func (*AwsGuardDutyDetectorFeaturesDetails) SetStatus added in v1.44.272 

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

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorFeaturesDetails) String added in v1.44.272 

func (s AwsGuardDutyDetectorFeaturesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

func (s *AwsIamAccessKeyDetails) SetAccessKeyId(v string) *AwsIamAccessKeyDetails

SetAccessKeyId sets the AccessKeyId field's value.

func (*AwsIamAccessKeyDetails) SetAccountId added in v1.35.0 

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

SetAccountId sets the AccountId field's value.

func (*AwsIamAccessKeyDetails) SetCreatedAt 

func (s *AwsIamAccessKeyDetails) SetCreatedAt(v string) *AwsIamAccessKeyDetails

SetCreatedAt sets the CreatedAt field's value.

func (*AwsIamAccessKeyDetails) SetPrincipalId added in v1.26.7 

func (s *AwsIamAccessKeyDetails) SetPrincipalId(v string) *AwsIamAccessKeyDetails

SetPrincipalId sets the PrincipalId field's value.

func (*AwsIamAccessKeyDetails) SetPrincipalName added in v1.26.7 

func (s *AwsIamAccessKeyDetails) SetPrincipalName(v string) *AwsIamAccessKeyDetails

SetPrincipalName sets the PrincipalName field's value.

func (*AwsIamAccessKeyDetails) SetPrincipalType added in v1.26.7 

func (s *AwsIamAccessKeyDetails) SetPrincipalType(v string) *AwsIamAccessKeyDetails

SetPrincipalType sets the PrincipalType field's value.

func (*AwsIamAccessKeyDetails) SetSessionContext added in v1.35.0 

func (s *AwsIamAccessKeyDetails) SetSessionContext(v *AwsIamAccessKeySessionContext) *AwsIamAccessKeyDetails

SetSessionContext sets the SessionContext field's value.

func (*AwsIamAccessKeyDetails) SetStatus 

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

SetStatus sets the Status field's value.

func (*AwsIamAccessKeyDetails) SetUserName 

func (s *AwsIamAccessKeyDetails) SetUserName(v string) *AwsIamAccessKeyDetails

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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsIamAccessKeySessionContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsIamAccessKeySessionContext) SetAttributes(v *AwsIamAccessKeySessionContextAttributes) *AwsIamAccessKeySessionContext

SetAttributes sets the Attributes field's value.

func (*AwsIamAccessKeySessionContext) SetSessionIssuer added in v1.35.0 

func (s *AwsIamAccessKeySessionContext) SetSessionIssuer(v *AwsIamAccessKeySessionContextSessionIssuer) *AwsIamAccessKeySessionContext

SetSessionIssuer sets the SessionIssuer field's value.

func (AwsIamAccessKeySessionContext) String added in v1.35.0 

func (s AwsIamAccessKeySessionContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

type AwsIamAccessKeySessionContextAttributes struct {

	// Indicates when the session was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

func (s AwsIamAccessKeySessionContextAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsIamAccessKeySessionContextAttributes) SetCreationDate(v string) *AwsIamAccessKeySessionContextAttributes

SetCreationDate sets the CreationDate field's value.

func (*AwsIamAccessKeySessionContextAttributes) SetMfaAuthenticated added in v1.35.0 

func (s *AwsIamAccessKeySessionContextAttributes) SetMfaAuthenticated(v bool) *AwsIamAccessKeySessionContextAttributes

SetMfaAuthenticated sets the MfaAuthenticated field's value.

func (AwsIamAccessKeySessionContextAttributes) String added in v1.35.0 

func (s AwsIamAccessKeySessionContextAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsIamAccessKeySessionContextSessionIssuer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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

SetAccountId sets the AccountId field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetArn added in v1.35.0 

func (s *AwsIamAccessKeySessionContextSessionIssuer) SetArn(v string) *AwsIamAccessKeySessionContextSessionIssuer

SetArn sets the Arn field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetPrincipalId added in v1.35.0 

func (s *AwsIamAccessKeySessionContextSessionIssuer) SetPrincipalId(v string) *AwsIamAccessKeySessionContextSessionIssuer

SetPrincipalId sets the PrincipalId field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetType added in v1.35.0 

func (s *AwsIamAccessKeySessionContextSessionIssuer) SetType(v string) *AwsIamAccessKeySessionContextSessionIssuer

SetType sets the Type field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetUserName added in v1.35.0 

func (s *AwsIamAccessKeySessionContextSessionIssuer) SetUserName(v string) *AwsIamAccessKeySessionContextSessionIssuer

SetUserName sets the UserName field's value.

func (AwsIamAccessKeySessionContextSessionIssuer) String added in v1.35.0 

func (s AwsIamAccessKeySessionContextSessionIssuer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsIamAttachedManagedPolicy) SetPolicyArn(v string) *AwsIamAttachedManagedPolicy

SetPolicyArn sets the PolicyArn field's value.

func (*AwsIamAttachedManagedPolicy) SetPolicyName added in v1.34.7 

func (s *AwsIamAttachedManagedPolicy) SetPolicyName(v string) *AwsIamAttachedManagedPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamAttachedManagedPolicy) String added in v1.34.7 

func (s AwsIamAttachedManagedPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamGroupDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamGroupDetails

SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.

func (*AwsIamGroupDetails) SetCreateDate added in v1.35.0 

func (s *AwsIamGroupDetails) SetCreateDate(v string) *AwsIamGroupDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamGroupDetails) SetGroupId added in v1.35.0 

func (s *AwsIamGroupDetails) SetGroupId(v string) *AwsIamGroupDetails

SetGroupId sets the GroupId field's value.

func (*AwsIamGroupDetails) SetGroupName added in v1.35.0 

func (s *AwsIamGroupDetails) SetGroupName(v string) *AwsIamGroupDetails

SetGroupName sets the GroupName field's value.

func (*AwsIamGroupDetails) SetGroupPolicyList added in v1.35.0 

func (s *AwsIamGroupDetails) SetGroupPolicyList(v []*AwsIamGroupPolicy) *AwsIamGroupDetails

SetGroupPolicyList sets the GroupPolicyList field's value.

func (*AwsIamGroupDetails) SetPath added in v1.35.0 

func (s *AwsIamGroupDetails) SetPath(v string) *AwsIamGroupDetails

SetPath sets the Path field's value.

func (AwsIamGroupDetails) String added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamGroupPolicy) SetPolicyName(v string) *AwsIamGroupPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamGroupPolicy) String added in v1.35.0 

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 added in v1.35.0 

type AwsIamInstanceProfile struct {

	// The ARN of the instance profile.
	Arn *string `type:"string"`

	// Indicates when the instance profile was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamInstanceProfile) SetArn(v string) *AwsIamInstanceProfile

SetArn sets the Arn field's value.

func (*AwsIamInstanceProfile) SetCreateDate added in v1.35.0 

func (s *AwsIamInstanceProfile) SetCreateDate(v string) *AwsIamInstanceProfile

SetCreateDate sets the CreateDate field's value.

func (*AwsIamInstanceProfile) SetInstanceProfileId added in v1.35.0 

func (s *AwsIamInstanceProfile) SetInstanceProfileId(v string) *AwsIamInstanceProfile

SetInstanceProfileId sets the InstanceProfileId field's value.

func (*AwsIamInstanceProfile) SetInstanceProfileName added in v1.35.0 

func (s *AwsIamInstanceProfile) SetInstanceProfileName(v string) *AwsIamInstanceProfile

SetInstanceProfileName sets the InstanceProfileName field's value.

func (*AwsIamInstanceProfile) SetPath added in v1.35.0 

func (s *AwsIamInstanceProfile) SetPath(v string) *AwsIamInstanceProfile

SetPath sets the Path field's value.

func (*AwsIamInstanceProfile) SetRoles added in v1.35.0 

func (s *AwsIamInstanceProfile) SetRoles(v []*AwsIamInstanceProfileRole) *AwsIamInstanceProfile

SetRoles sets the Roles field's value.

func (AwsIamInstanceProfile) String added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamInstanceProfile) Validate() error

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

type AwsIamInstanceProfileRole added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamInstanceProfileRole) SetArn(v string) *AwsIamInstanceProfileRole

SetArn sets the Arn field's value.

func (*AwsIamInstanceProfileRole) SetAssumeRolePolicyDocument added in v1.35.0 

func (s *AwsIamInstanceProfileRole) SetAssumeRolePolicyDocument(v string) *AwsIamInstanceProfileRole

SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.

func (*AwsIamInstanceProfileRole) SetCreateDate added in v1.35.0 

func (s *AwsIamInstanceProfileRole) SetCreateDate(v string) *AwsIamInstanceProfileRole

SetCreateDate sets the CreateDate field's value.

func (*AwsIamInstanceProfileRole) SetPath added in v1.35.0 

func (s *AwsIamInstanceProfileRole) SetPath(v string) *AwsIamInstanceProfileRole

SetPath sets the Path field's value.

func (*AwsIamInstanceProfileRole) SetRoleId added in v1.35.0 

func (s *AwsIamInstanceProfileRole) SetRoleId(v string) *AwsIamInstanceProfileRole

SetRoleId sets the RoleId field's value.

func (*AwsIamInstanceProfileRole) SetRoleName added in v1.35.0 

func (s *AwsIamInstanceProfileRole) SetRoleName(v string) *AwsIamInstanceProfileRole

SetRoleName sets the RoleName field's value.

func (AwsIamInstanceProfileRole) String added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamInstanceProfileRole) Validate() error

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

type AwsIamPermissionsBoundary added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryArn(v string) *AwsIamPermissionsBoundary

SetPermissionsBoundaryArn sets the PermissionsBoundaryArn field's value.

func (*AwsIamPermissionsBoundary) SetPermissionsBoundaryType added in v1.34.7 

func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryType(v string) *AwsIamPermissionsBoundary

SetPermissionsBoundaryType sets the PermissionsBoundaryType field's value.

func (AwsIamPermissionsBoundary) String added in v1.34.7 

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 added in v1.34.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	UpdateDate *string `type:"string"`
	// contains filtered or unexported fields
}

Represents an IAM permissions policy.

func (AwsIamPolicyDetails) GoString added in v1.34.7 

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 added in v1.34.7 

func (s *AwsIamPolicyDetails) SetAttachmentCount(v int64) *AwsIamPolicyDetails

SetAttachmentCount sets the AttachmentCount field's value.

func (*AwsIamPolicyDetails) SetCreateDate added in v1.34.7 

func (s *AwsIamPolicyDetails) SetCreateDate(v string) *AwsIamPolicyDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamPolicyDetails) SetDefaultVersionId added in v1.34.7 

func (s *AwsIamPolicyDetails) SetDefaultVersionId(v string) *AwsIamPolicyDetails

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*AwsIamPolicyDetails) SetDescription added in v1.34.7 

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

SetDescription sets the Description field's value.

func (*AwsIamPolicyDetails) SetIsAttachable added in v1.34.7 

func (s *AwsIamPolicyDetails) SetIsAttachable(v bool) *AwsIamPolicyDetails

SetIsAttachable sets the IsAttachable field's value.

func (*AwsIamPolicyDetails) SetPath added in v1.34.7 

func (s *AwsIamPolicyDetails) SetPath(v string) *AwsIamPolicyDetails

SetPath sets the Path field's value.

func (*AwsIamPolicyDetails) SetPermissionsBoundaryUsageCount added in v1.34.7 

func (s *AwsIamPolicyDetails) SetPermissionsBoundaryUsageCount(v int64) *AwsIamPolicyDetails

SetPermissionsBoundaryUsageCount sets the PermissionsBoundaryUsageCount field's value.

func (*AwsIamPolicyDetails) SetPolicyId added in v1.34.7 

func (s *AwsIamPolicyDetails) SetPolicyId(v string) *AwsIamPolicyDetails

SetPolicyId sets the PolicyId field's value.

func (*AwsIamPolicyDetails) SetPolicyName added in v1.34.7 

func (s *AwsIamPolicyDetails) SetPolicyName(v string) *AwsIamPolicyDetails

SetPolicyName sets the PolicyName field's value.

func (*AwsIamPolicyDetails) SetPolicyVersionList added in v1.34.7 

func (s *AwsIamPolicyDetails) SetPolicyVersionList(v []*AwsIamPolicyVersion) *AwsIamPolicyDetails

SetPolicyVersionList sets the PolicyVersionList field's value.

func (*AwsIamPolicyDetails) SetUpdateDate added in v1.34.7 

func (s *AwsIamPolicyDetails) SetUpdateDate(v string) *AwsIamPolicyDetails

SetUpdateDate sets the UpdateDate field's value.

func (AwsIamPolicyDetails) String added in v1.34.7 

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 added in v1.34.7 

type AwsIamPolicyVersion struct {

	// Indicates when the version was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsIamPolicyVersion) SetCreateDate(v string) *AwsIamPolicyVersion

SetCreateDate sets the CreateDate field's value.

func (*AwsIamPolicyVersion) SetIsDefaultVersion added in v1.34.7 

func (s *AwsIamPolicyVersion) SetIsDefaultVersion(v bool) *AwsIamPolicyVersion

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*AwsIamPolicyVersion) SetVersionId added in v1.34.7 

func (s *AwsIamPolicyVersion) SetVersionId(v string) *AwsIamPolicyVersion

SetVersionId sets the VersionId field's value.

func (AwsIamPolicyVersion) String added in v1.34.7 

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 added in v1.26.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsIamRoleDetails) SetAssumeRolePolicyDocument(v string) *AwsIamRoleDetails

SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.

func (*AwsIamRoleDetails) SetAttachedManagedPolicies added in v1.35.0 

func (s *AwsIamRoleDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamRoleDetails

SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.

func (*AwsIamRoleDetails) SetCreateDate added in v1.26.7 

func (s *AwsIamRoleDetails) SetCreateDate(v string) *AwsIamRoleDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamRoleDetails) SetInstanceProfileList added in v1.35.0 

func (s *AwsIamRoleDetails) SetInstanceProfileList(v []*AwsIamInstanceProfile) *AwsIamRoleDetails

SetInstanceProfileList sets the InstanceProfileList field's value.

func (*AwsIamRoleDetails) SetMaxSessionDuration added in v1.26.7 

func (s *AwsIamRoleDetails) SetMaxSessionDuration(v int64) *AwsIamRoleDetails

SetMaxSessionDuration sets the MaxSessionDuration field's value.

func (*AwsIamRoleDetails) SetPath added in v1.26.7 

func (s *AwsIamRoleDetails) SetPath(v string) *AwsIamRoleDetails

SetPath sets the Path field's value.

func (*AwsIamRoleDetails) SetPermissionsBoundary added in v1.35.0 

func (s *AwsIamRoleDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamRoleDetails

SetPermissionsBoundary sets the PermissionsBoundary field's value.

func (*AwsIamRoleDetails) SetRoleId added in v1.26.7 

func (s *AwsIamRoleDetails) SetRoleId(v string) *AwsIamRoleDetails

SetRoleId sets the RoleId field's value.

func (*AwsIamRoleDetails) SetRoleName added in v1.26.7 

func (s *AwsIamRoleDetails) SetRoleName(v string) *AwsIamRoleDetails

SetRoleName sets the RoleName field's value.

func (*AwsIamRoleDetails) SetRolePolicyList added in v1.35.0 

func (s *AwsIamRoleDetails) SetRolePolicyList(v []*AwsIamRolePolicy) *AwsIamRoleDetails

SetRolePolicyList sets the RolePolicyList field's value.

func (AwsIamRoleDetails) String added in v1.26.7 

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 added in v1.26.7 

func (s *AwsIamRoleDetails) Validate() error

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

type AwsIamRolePolicy added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsIamRolePolicy) SetPolicyName(v string) *AwsIamRolePolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamRolePolicy) String added in v1.35.0 

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 added in v1.34.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsIamUserDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamUserDetails

SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.

func (*AwsIamUserDetails) SetCreateDate added in v1.34.7 

func (s *AwsIamUserDetails) SetCreateDate(v string) *AwsIamUserDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamUserDetails) SetGroupList added in v1.34.7 

func (s *AwsIamUserDetails) SetGroupList(v []*string) *AwsIamUserDetails

SetGroupList sets the GroupList field's value.

func (*AwsIamUserDetails) SetPath added in v1.34.7 

func (s *AwsIamUserDetails) SetPath(v string) *AwsIamUserDetails

SetPath sets the Path field's value.

func (*AwsIamUserDetails) SetPermissionsBoundary added in v1.34.7 

func (s *AwsIamUserDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamUserDetails

SetPermissionsBoundary sets the PermissionsBoundary field's value.

func (*AwsIamUserDetails) SetUserId added in v1.34.7 

func (s *AwsIamUserDetails) SetUserId(v string) *AwsIamUserDetails

SetUserId sets the UserId field's value.

func (*AwsIamUserDetails) SetUserName added in v1.34.7 

func (s *AwsIamUserDetails) SetUserName(v string) *AwsIamUserDetails

SetUserName sets the UserName field's value.

func (*AwsIamUserDetails) SetUserPolicyList added in v1.34.7 

func (s *AwsIamUserDetails) SetUserPolicyList(v []*AwsIamUserPolicy) *AwsIamUserDetails

SetUserPolicyList sets the UserPolicyList field's value.

func (AwsIamUserDetails) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsIamUserPolicy) SetPolicyName(v string) *AwsIamUserPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamUserPolicy) String added in v1.34.7 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsKinesisStreamDetails) SetArn(v string) *AwsKinesisStreamDetails

SetArn sets the Arn field's value.

func (*AwsKinesisStreamDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsKinesisStreamDetails) SetRetentionPeriodHours added in v1.44.36 

func (s *AwsKinesisStreamDetails) SetRetentionPeriodHours(v int64) *AwsKinesisStreamDetails

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

func (*AwsKinesisStreamDetails) SetShardCount added in v1.44.36 

func (s *AwsKinesisStreamDetails) SetShardCount(v int64) *AwsKinesisStreamDetails

SetShardCount sets the ShardCount field's value.

func (*AwsKinesisStreamDetails) SetStreamEncryption added in v1.44.36 

func (s *AwsKinesisStreamDetails) SetStreamEncryption(v *AwsKinesisStreamStreamEncryptionDetails) *AwsKinesisStreamDetails

SetStreamEncryption sets the StreamEncryption field's value.

func (AwsKinesisStreamDetails) String added in v1.44.36 

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.44.36 

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.44.36 

func (s AwsKinesisStreamStreamEncryptionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsKinesisStreamStreamEncryptionDetails) SetEncryptionType(v string) *AwsKinesisStreamStreamEncryptionDetails

SetEncryptionType sets the EncryptionType field's value.

func (*AwsKinesisStreamStreamEncryptionDetails) SetKeyId added in v1.44.36 

func (s *AwsKinesisStreamStreamEncryptionDetails) SetKeyId(v string) *AwsKinesisStreamStreamEncryptionDetails

SetKeyId sets the KeyId field's value.

func (AwsKinesisStreamStreamEncryptionDetails) String added in v1.44.36 

func (s AwsKinesisStreamStreamEncryptionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsKmsKeyDetails) SetAWSAccountId(v string) *AwsKmsKeyDetails

SetAWSAccountId sets the AWSAccountId field's value.

func (*AwsKmsKeyDetails) SetCreationDate added in v1.26.7 

func (s *AwsKmsKeyDetails) SetCreationDate(v float64) *AwsKmsKeyDetails

SetCreationDate sets the CreationDate field's value.

func (*AwsKmsKeyDetails) SetDescription added in v1.34.7 

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

SetDescription sets the Description field's value.

func (*AwsKmsKeyDetails) SetKeyId added in v1.26.7 

func (s *AwsKmsKeyDetails) SetKeyId(v string) *AwsKmsKeyDetails

SetKeyId sets the KeyId field's value.

func (*AwsKmsKeyDetails) SetKeyManager added in v1.26.7 

func (s *AwsKmsKeyDetails) SetKeyManager(v string) *AwsKmsKeyDetails

SetKeyManager sets the KeyManager field's value.

func (*AwsKmsKeyDetails) SetKeyRotationStatus added in v1.40.36 

func (s *AwsKmsKeyDetails) SetKeyRotationStatus(v bool) *AwsKmsKeyDetails

SetKeyRotationStatus sets the KeyRotationStatus field's value.

func (*AwsKmsKeyDetails) SetKeyState added in v1.26.7 

func (s *AwsKmsKeyDetails) SetKeyState(v string) *AwsKmsKeyDetails

SetKeyState sets the KeyState field's value.

func (*AwsKmsKeyDetails) SetOrigin added in v1.26.7 

func (s *AwsKmsKeyDetails) SetOrigin(v string) *AwsKmsKeyDetails

SetOrigin sets the Origin field's value.

func (AwsKmsKeyDetails) String added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsLambdaFunctionCode) SetS3Bucket(v string) *AwsLambdaFunctionCode

SetS3Bucket sets the S3Bucket field's value.

func (*AwsLambdaFunctionCode) SetS3Key added in v1.26.7 

func (s *AwsLambdaFunctionCode) SetS3Key(v string) *AwsLambdaFunctionCode

SetS3Key sets the S3Key field's value.

func (*AwsLambdaFunctionCode) SetS3ObjectVersion added in v1.26.7 

func (s *AwsLambdaFunctionCode) SetS3ObjectVersion(v string) *AwsLambdaFunctionCode

SetS3ObjectVersion sets the S3ObjectVersion field's value.

func (*AwsLambdaFunctionCode) SetZipFile added in v1.26.7 

func (s *AwsLambdaFunctionCode) SetZipFile(v string) *AwsLambdaFunctionCode

SetZipFile sets the ZipFile field's value.

func (AwsLambdaFunctionCode) String added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s AwsLambdaFunctionDeadLetterConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

func (s *AwsLambdaFunctionDeadLetterConfig) SetTargetArn(v string) *AwsLambdaFunctionDeadLetterConfig

SetTargetArn sets the TargetArn field's value.

func (AwsLambdaFunctionDeadLetterConfig) String added in v1.26.7 

func (s AwsLambdaFunctionDeadLetterConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.26.7 

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.44.140 

func (s *AwsLambdaFunctionDetails) SetArchitectures(v []*string) *AwsLambdaFunctionDetails

SetArchitectures sets the Architectures field's value.

func (*AwsLambdaFunctionDetails) SetCode added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetCode(v *AwsLambdaFunctionCode) *AwsLambdaFunctionDetails

SetCode sets the Code field's value.

func (*AwsLambdaFunctionDetails) SetCodeSha256 added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetCodeSha256(v string) *AwsLambdaFunctionDetails

SetCodeSha256 sets the CodeSha256 field's value.

func (*AwsLambdaFunctionDetails) SetDeadLetterConfig added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetDeadLetterConfig(v *AwsLambdaFunctionDeadLetterConfig) *AwsLambdaFunctionDetails

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*AwsLambdaFunctionDetails) SetEnvironment added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetEnvironment(v *AwsLambdaFunctionEnvironment) *AwsLambdaFunctionDetails

SetEnvironment sets the Environment field's value.

func (*AwsLambdaFunctionDetails) SetFunctionName added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetFunctionName(v string) *AwsLambdaFunctionDetails

SetFunctionName sets the FunctionName field's value.

func (*AwsLambdaFunctionDetails) SetHandler added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetHandler(v string) *AwsLambdaFunctionDetails

SetHandler sets the Handler field's value.

func (*AwsLambdaFunctionDetails) SetKmsKeyArn added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetKmsKeyArn(v string) *AwsLambdaFunctionDetails

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*AwsLambdaFunctionDetails) SetLastModified added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetLastModified(v string) *AwsLambdaFunctionDetails

SetLastModified sets the LastModified field's value.

func (*AwsLambdaFunctionDetails) SetLayers added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetLayers(v []*AwsLambdaFunctionLayer) *AwsLambdaFunctionDetails

SetLayers sets the Layers field's value.

func (*AwsLambdaFunctionDetails) SetMasterArn added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetMasterArn(v string) *AwsLambdaFunctionDetails

SetMasterArn sets the MasterArn field's value.

func (*AwsLambdaFunctionDetails) SetMemorySize added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetMemorySize(v int64) *AwsLambdaFunctionDetails

SetMemorySize sets the MemorySize field's value.

func (*AwsLambdaFunctionDetails) SetPackageType added in v1.44.140 

func (s *AwsLambdaFunctionDetails) SetPackageType(v string) *AwsLambdaFunctionDetails

SetPackageType sets the PackageType field's value.

func (*AwsLambdaFunctionDetails) SetRevisionId added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetRevisionId(v string) *AwsLambdaFunctionDetails

SetRevisionId sets the RevisionId field's value.

func (*AwsLambdaFunctionDetails) SetRole added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetRole(v string) *AwsLambdaFunctionDetails

SetRole sets the Role field's value.

func (*AwsLambdaFunctionDetails) SetRuntime added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetRuntime(v string) *AwsLambdaFunctionDetails

SetRuntime sets the Runtime field's value.

func (*AwsLambdaFunctionDetails) SetTimeout added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetTimeout(v int64) *AwsLambdaFunctionDetails

SetTimeout sets the Timeout field's value.

func (*AwsLambdaFunctionDetails) SetTracingConfig added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetTracingConfig(v *AwsLambdaFunctionTracingConfig) *AwsLambdaFunctionDetails

SetTracingConfig sets the TracingConfig field's value.

func (*AwsLambdaFunctionDetails) SetVersion added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetVersion(v string) *AwsLambdaFunctionDetails

SetVersion sets the Version field's value.

func (*AwsLambdaFunctionDetails) SetVpcConfig added in v1.26.7 

func (s *AwsLambdaFunctionDetails) SetVpcConfig(v *AwsLambdaFunctionVpcConfig) *AwsLambdaFunctionDetails

SetVpcConfig sets the VpcConfig field's value.

func (AwsLambdaFunctionDetails) String added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsLambdaFunctionEnvironment) SetError(v *AwsLambdaFunctionEnvironmentError) *AwsLambdaFunctionEnvironment

SetError sets the Error field's value.

func (*AwsLambdaFunctionEnvironment) SetVariables added in v1.26.7 

func (s *AwsLambdaFunctionEnvironment) SetVariables(v map[string]*string) *AwsLambdaFunctionEnvironment

SetVariables sets the Variables field's value.

func (AwsLambdaFunctionEnvironment) String added in v1.26.7 

func (s AwsLambdaFunctionEnvironment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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 added in v1.26.7 

func (s AwsLambdaFunctionEnvironmentError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

func (s *AwsLambdaFunctionEnvironmentError) SetErrorCode(v string) *AwsLambdaFunctionEnvironmentError

SetErrorCode sets the ErrorCode field's value.

func (*AwsLambdaFunctionEnvironmentError) SetMessage added in v1.26.7 

func (s *AwsLambdaFunctionEnvironmentError) SetMessage(v string) *AwsLambdaFunctionEnvironmentError

SetMessage sets the Message field's value.

func (AwsLambdaFunctionEnvironmentError) String added in v1.26.7 

func (s AwsLambdaFunctionEnvironmentError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsLambdaFunctionLayer) SetArn(v string) *AwsLambdaFunctionLayer

SetArn sets the Arn field's value.

func (*AwsLambdaFunctionLayer) SetCodeSize added in v1.26.7 

func (s *AwsLambdaFunctionLayer) SetCodeSize(v int64) *AwsLambdaFunctionLayer

SetCodeSize sets the CodeSize field's value.

func (AwsLambdaFunctionLayer) String added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s AwsLambdaFunctionTracingConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

func (s *AwsLambdaFunctionTracingConfig) SetMode(v string) *AwsLambdaFunctionTracingConfig

SetMode sets the Mode field's value.

func (AwsLambdaFunctionTracingConfig) String added in v1.26.7 

func (s AwsLambdaFunctionTracingConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsLambdaFunctionVpcConfig) SetSecurityGroupIds(v []*string) *AwsLambdaFunctionVpcConfig

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsLambdaFunctionVpcConfig) SetSubnetIds added in v1.26.7 

func (s *AwsLambdaFunctionVpcConfig) SetSubnetIds(v []*string) *AwsLambdaFunctionVpcConfig

SetSubnetIds sets the SubnetIds field's value.

func (*AwsLambdaFunctionVpcConfig) SetVpcId added in v1.26.7 

func (s *AwsLambdaFunctionVpcConfig) SetVpcId(v string) *AwsLambdaFunctionVpcConfig

SetVpcId sets the VpcId field's value.

func (AwsLambdaFunctionVpcConfig) String added in v1.26.7 

func (s AwsLambdaFunctionVpcConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

type AwsLambdaLayerVersionDetails struct {

	// The layer's compatible function runtimes (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
	//
	// The following list includes deprecated runtimes. For more information, see
	// Runtime deprecation policy (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)
	// in the Lambda Developer Guide.
	//
	// Array Members: Maximum number of 5 items.
	//
	// Valid Values: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x |
	// nodejs12.x | nodejs14.x | nodejs16.x | java8 | java8.al2 | java11 | python2.7
	// | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0
	// | dotnetcore2.1 | dotnetcore3.1 | dotnet6 | nodejs4.3-edge | go1.x | ruby2.5
	// | ruby2.7 | provided | provided.al2 | nodejs18.x | python3.10 | java17 |
	// ruby3.2 | python3.11 | nodejs20.x | provided.al2023 | python3.12 | java21
	CompatibleRuntimes []*string `type:"list"`

	// Indicates when the version was created.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsLambdaLayerVersionDetails) SetCompatibleRuntimes(v []*string) *AwsLambdaLayerVersionDetails

SetCompatibleRuntimes sets the CompatibleRuntimes field's value.

func (*AwsLambdaLayerVersionDetails) SetCreatedDate added in v1.28.11 

func (s *AwsLambdaLayerVersionDetails) SetCreatedDate(v string) *AwsLambdaLayerVersionDetails

SetCreatedDate sets the CreatedDate field's value.

func (*AwsLambdaLayerVersionDetails) SetVersion added in v1.28.11 

func (s *AwsLambdaLayerVersionDetails) SetVersion(v int64) *AwsLambdaLayerVersionDetails

SetVersion sets the Version field's value.

func (AwsLambdaLayerVersionDetails) String added in v1.28.11 

func (s AwsLambdaLayerVersionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsMountPoint) SetContainerPath(v string) *AwsMountPoint

SetContainerPath sets the ContainerPath field's value.

func (*AwsMountPoint) SetSourceVolume added in v1.44.36 

func (s *AwsMountPoint) SetSourceVolume(v string) *AwsMountPoint

SetSourceVolume sets the SourceVolume field's value.

func (AwsMountPoint) String added in v1.44.36 

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 AwsMskClusterClusterInfoClientAuthenticationDetails added in v1.45.23 

type AwsMskClusterClusterInfoClientAuthenticationDetails struct {

	// Provides details for client authentication using SASL.
	Sasl *AwsMskClusterClusterInfoClientAuthenticationSaslDetails `type:"structure"`

	// Provides details for client authentication using TLS.
	Tls *AwsMskClusterClusterInfoClientAuthenticationTlsDetails `type:"structure"`

	// Provides details for allowing no client authentication.
	Unauthenticated *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about different modes of client authentication.

func (AwsMskClusterClusterInfoClientAuthenticationDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoClientAuthenticationDetails) SetSasl added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationDetails) SetSasl(v *AwsMskClusterClusterInfoClientAuthenticationSaslDetails) *AwsMskClusterClusterInfoClientAuthenticationDetails

SetSasl sets the Sasl field's value.

func (*AwsMskClusterClusterInfoClientAuthenticationDetails) SetTls added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationDetails) SetTls(v *AwsMskClusterClusterInfoClientAuthenticationTlsDetails) *AwsMskClusterClusterInfoClientAuthenticationDetails

SetTls sets the Tls field's value.

func (*AwsMskClusterClusterInfoClientAuthenticationDetails) SetUnauthenticated added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationDetails) SetUnauthenticated(v *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) *AwsMskClusterClusterInfoClientAuthenticationDetails

SetUnauthenticated sets the Unauthenticated field's value.

func (AwsMskClusterClusterInfoClientAuthenticationDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoClientAuthenticationSaslDetails added in v1.45.23 

type AwsMskClusterClusterInfoClientAuthenticationSaslDetails struct {

	// Provides details for SASL client authentication using IAM.
	Iam *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails `type:"structure"`

	// Details for SASL client authentication using SCRAM.
	Scram *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details for client authentication using SASL.

func (AwsMskClusterClusterInfoClientAuthenticationSaslDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationSaslDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoClientAuthenticationSaslDetails) SetIam added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationSaslDetails) SetIam(v *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) *AwsMskClusterClusterInfoClientAuthenticationSaslDetails

SetIam sets the Iam field's value.

func (*AwsMskClusterClusterInfoClientAuthenticationSaslDetails) SetScram added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationSaslDetails) SetScram(v *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) *AwsMskClusterClusterInfoClientAuthenticationSaslDetails

SetScram sets the Scram field's value.

func (AwsMskClusterClusterInfoClientAuthenticationSaslDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationSaslDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails added in v1.45.23 

type AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails struct {

	// Indicates whether SASL/IAM authentication is enabled or not.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Details for SASL/IAM client authentication.

func (AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) SetEnabled added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails

SetEnabled sets the Enabled field's value.

func (AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails added in v1.45.23 

type AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails struct {

	// Indicates whether SASL/SCRAM authentication is enabled or not.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Details for SASL/SCRAM client authentication.

func (AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) SetEnabled added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails

SetEnabled sets the Enabled field's value.

func (AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoClientAuthenticationTlsDetails added in v1.45.23 

type AwsMskClusterClusterInfoClientAuthenticationTlsDetails struct {

	// List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon
	// Web Services Private CA enables creation of private certificate authority
	// (CA) hierarchies, including root and subordinate CAs, without the investment
	// and maintenance costs of operating an on-premises CA.
	CertificateAuthorityArnList []*string `type:"list"`

	// Indicates whether TLS authentication is enabled or not.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides details for client authentication using TLS.

func (AwsMskClusterClusterInfoClientAuthenticationTlsDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationTlsDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoClientAuthenticationTlsDetails) SetCertificateAuthorityArnList added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationTlsDetails) SetCertificateAuthorityArnList(v []*string) *AwsMskClusterClusterInfoClientAuthenticationTlsDetails

SetCertificateAuthorityArnList sets the CertificateAuthorityArnList field's value.

func (*AwsMskClusterClusterInfoClientAuthenticationTlsDetails) SetEnabled added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationTlsDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationTlsDetails

SetEnabled sets the Enabled field's value.

func (AwsMskClusterClusterInfoClientAuthenticationTlsDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationTlsDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails added in v1.45.23 

type AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails struct {

	// Indicates whether unauthenticated is allowed or not.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides details for allowing no client authentication.

func (AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) SetEnabled added in v1.45.23 

func (s *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails

SetEnabled sets the Enabled field's value.

func (AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoDetails added in v1.45.23 

type AwsMskClusterClusterInfoDetails struct {

	// Provides information for different modes of client authentication.
	ClientAuthentication *AwsMskClusterClusterInfoClientAuthenticationDetails `type:"structure"`

	// The name of the cluster.
	ClusterName *string `type:"string"`

	// The current version of the cluster.
	CurrentVersion *string `type:"string"`

	// Includes encryption-related information, such as the KMS key used for encrypting
	// data at rest and whether you want Amazon MSK to encrypt your data in transit.
	EncryptionInfo *AwsMskClusterClusterInfoEncryptionInfoDetails `type:"structure"`

	// Specifies the level of monitoring for the cluster.
	EnhancedMonitoring *string `type:"string"`

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provide details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.

func (AwsMskClusterClusterInfoDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoDetails) SetClientAuthentication added in v1.45.23 

func (s *AwsMskClusterClusterInfoDetails) SetClientAuthentication(v *AwsMskClusterClusterInfoClientAuthenticationDetails) *AwsMskClusterClusterInfoDetails

SetClientAuthentication sets the ClientAuthentication field's value.

func (*AwsMskClusterClusterInfoDetails) SetClusterName added in v1.45.23 

func (s *AwsMskClusterClusterInfoDetails) SetClusterName(v string) *AwsMskClusterClusterInfoDetails

SetClusterName sets the ClusterName field's value.

func (*AwsMskClusterClusterInfoDetails) SetCurrentVersion added in v1.45.23 

func (s *AwsMskClusterClusterInfoDetails) SetCurrentVersion(v string) *AwsMskClusterClusterInfoDetails

SetCurrentVersion sets the CurrentVersion field's value.

func (*AwsMskClusterClusterInfoDetails) SetEncryptionInfo added in v1.45.23 

func (s *AwsMskClusterClusterInfoDetails) SetEncryptionInfo(v *AwsMskClusterClusterInfoEncryptionInfoDetails) *AwsMskClusterClusterInfoDetails

SetEncryptionInfo sets the EncryptionInfo field's value.

func (*AwsMskClusterClusterInfoDetails) SetEnhancedMonitoring added in v1.49.0 

func (s *AwsMskClusterClusterInfoDetails) SetEnhancedMonitoring(v string) *AwsMskClusterClusterInfoDetails

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*AwsMskClusterClusterInfoDetails) SetNumberOfBrokerNodes added in v1.45.23 

func (s *AwsMskClusterClusterInfoDetails) SetNumberOfBrokerNodes(v int64) *AwsMskClusterClusterInfoDetails

SetNumberOfBrokerNodes sets the NumberOfBrokerNodes field's value.

func (AwsMskClusterClusterInfoDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoEncryptionInfoDetails added in v1.45.23 

type AwsMskClusterClusterInfoEncryptionInfoDetails struct {

	// The data-volume encryption details. You can't update encryption at rest settings
	// for existing clusters.
	EncryptionAtRest *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails `type:"structure"`

	// The settings for encrypting data in transit.
	EncryptionInTransit *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails `type:"structure"`
	// contains filtered or unexported fields
}

Includes encryption-related information, such as the KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

func (AwsMskClusterClusterInfoEncryptionInfoDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoEncryptionInfoDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoEncryptionInfoDetails) SetEncryptionAtRest added in v1.45.23 

func (s *AwsMskClusterClusterInfoEncryptionInfoDetails) SetEncryptionAtRest(v *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) *AwsMskClusterClusterInfoEncryptionInfoDetails

SetEncryptionAtRest sets the EncryptionAtRest field's value.

func (*AwsMskClusterClusterInfoEncryptionInfoDetails) SetEncryptionInTransit added in v1.45.23 

func (s *AwsMskClusterClusterInfoEncryptionInfoDetails) SetEncryptionInTransit(v *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) *AwsMskClusterClusterInfoEncryptionInfoDetails

SetEncryptionInTransit sets the EncryptionInTransit field's value.

func (AwsMskClusterClusterInfoEncryptionInfoDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoEncryptionInfoDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails added in v1.45.23 

type AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails struct {

	// The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest.
	// If you don't specify a KMS key, MSK creates one for you and uses it.
	DataVolumeKMSKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

The data-volume encryption details. You can't update encryption at rest settings for existing clusters.

func (AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) SetDataVolumeKMSKeyId added in v1.45.23 

func (s *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) SetDataVolumeKMSKeyId(v string) *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails

SetDataVolumeKMSKeyId sets the DataVolumeKMSKeyId field's value.

func (AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) String() string

String returns the string representation.

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

type AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails added in v1.45.23 

type AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails struct {

	// Indicates the encryption setting for data in transit between clients and
	// brokers.
	ClientBroker *string `type:"string"`

	// When set to true, it indicates that data communication among the broker nodes
	// of the cluster is encrypted. When set to false, the communication happens
	// in plain text. The default value is true.
	InCluster *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The settings for encrypting data in transit.

func (AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) GoString added in v1.45.23 

func (s AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) SetClientBroker added in v1.45.23 

func (s *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) SetClientBroker(v string) *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails

SetClientBroker sets the ClientBroker field's value.

func (*AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) SetInCluster added in v1.45.23 

func (s *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) SetInCluster(v bool) *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails

SetInCluster sets the InCluster field's value.

func (AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) String added in v1.45.23 

func (s AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) String() string

String returns the string representation.

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

type AwsMskClusterDetails added in v1.45.23 

type AwsMskClusterDetails struct {

	// Provides information about a cluster.
	ClusterInfo *AwsMskClusterClusterInfoDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.

func (AwsMskClusterDetails) GoString added in v1.45.23 

func (s AwsMskClusterDetails) GoString() string

GoString returns the string representation.

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

func (*AwsMskClusterDetails) SetClusterInfo added in v1.45.23 

func (s *AwsMskClusterDetails) SetClusterInfo(v *AwsMskClusterClusterInfoDetails) *AwsMskClusterDetails

SetClusterInfo sets the ClusterInfo field's value.

func (AwsMskClusterDetails) String added in v1.45.23 

func (s AwsMskClusterDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsNetworkFirewallFirewallDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsNetworkFirewallFirewallDetails) SetDeleteProtection(v bool) *AwsNetworkFirewallFirewallDetails

SetDeleteProtection sets the DeleteProtection field's value.

func (*AwsNetworkFirewallFirewallDetails) SetDescription added in v1.42.24 

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

SetDescription sets the Description field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallArn added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetFirewallArn(v string) *AwsNetworkFirewallFirewallDetails

SetFirewallArn sets the FirewallArn field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallId added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetFirewallId(v string) *AwsNetworkFirewallFirewallDetails

SetFirewallId sets the FirewallId field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallName added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetFirewallName(v string) *AwsNetworkFirewallFirewallDetails

SetFirewallName sets the FirewallName field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallPolicyArn added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetFirewallPolicyArn(v string) *AwsNetworkFirewallFirewallDetails

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallPolicyChangeProtection added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetFirewallPolicyChangeProtection(v bool) *AwsNetworkFirewallFirewallDetails

SetFirewallPolicyChangeProtection sets the FirewallPolicyChangeProtection field's value.

func (*AwsNetworkFirewallFirewallDetails) SetSubnetChangeProtection added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetSubnetChangeProtection(v bool) *AwsNetworkFirewallFirewallDetails

SetSubnetChangeProtection sets the SubnetChangeProtection field's value.

func (*AwsNetworkFirewallFirewallDetails) SetSubnetMappings added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetSubnetMappings(v []*AwsNetworkFirewallFirewallSubnetMappingsDetails) *AwsNetworkFirewallFirewallDetails

SetSubnetMappings sets the SubnetMappings field's value.

func (*AwsNetworkFirewallFirewallDetails) SetVpcId added in v1.42.24 

func (s *AwsNetworkFirewallFirewallDetails) SetVpcId(v string) *AwsNetworkFirewallFirewallDetails

SetVpcId sets the VpcId field's value.

func (AwsNetworkFirewallFirewallDetails) String added in v1.42.24 

func (s AwsNetworkFirewallFirewallDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsNetworkFirewallFirewallPolicyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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

SetDescription sets the Description field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicy added in v1.42.24 

func (s *AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicy(v *FirewallPolicyDetails) *AwsNetworkFirewallFirewallPolicyDetails

SetFirewallPolicy sets the FirewallPolicy field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyArn added in v1.42.24 

func (s *AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyArn(v string) *AwsNetworkFirewallFirewallPolicyDetails

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyId added in v1.42.24 

func (s *AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyId(v string) *AwsNetworkFirewallFirewallPolicyDetails

SetFirewallPolicyId sets the FirewallPolicyId field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyName added in v1.42.24 

func (s *AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyName(v string) *AwsNetworkFirewallFirewallPolicyDetails

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (AwsNetworkFirewallFirewallPolicyDetails) String added in v1.42.24 

func (s AwsNetworkFirewallFirewallPolicyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsNetworkFirewallFirewallSubnetMappingsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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

SetSubnetId sets the SubnetId field's value.

func (AwsNetworkFirewallFirewallSubnetMappingsDetails) String added in v1.42.24 

func (s AwsNetworkFirewallFirewallSubnetMappingsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsNetworkFirewallRuleGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsNetworkFirewallRuleGroupDetails) SetCapacity(v int64) *AwsNetworkFirewallRuleGroupDetails

SetCapacity sets the Capacity field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetDescription added in v1.42.24 

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

SetDescription sets the Description field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroup added in v1.42.24 

func (s *AwsNetworkFirewallRuleGroupDetails) SetRuleGroup(v *RuleGroupDetails) *AwsNetworkFirewallRuleGroupDetails

SetRuleGroup sets the RuleGroup field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroupArn added in v1.42.24 

func (s *AwsNetworkFirewallRuleGroupDetails) SetRuleGroupArn(v string) *AwsNetworkFirewallRuleGroupDetails

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroupId added in v1.42.24 

func (s *AwsNetworkFirewallRuleGroupDetails) SetRuleGroupId(v string) *AwsNetworkFirewallRuleGroupDetails

SetRuleGroupId sets the RuleGroupId field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroupName added in v1.42.24 

func (s *AwsNetworkFirewallRuleGroupDetails) SetRuleGroupName(v string) *AwsNetworkFirewallRuleGroupDetails

SetRuleGroupName sets the RuleGroupName field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetType added in v1.42.24 

func (s *AwsNetworkFirewallRuleGroupDetails) SetType(v string) *AwsNetworkFirewallRuleGroupDetails

SetType sets the Type field's value.

func (AwsNetworkFirewallRuleGroupDetails) String added in v1.42.24 

func (s AwsNetworkFirewallRuleGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetEnabled(v bool) *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails

SetEnabled sets the Enabled field's value.

func (*AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetInternalUserDatabaseEnabled added in v1.44.36 

func (s *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetInternalUserDatabaseEnabled(v bool) *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails

SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.

func (*AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetMasterUserOptions added in v1.44.36 

func (s *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetMasterUserOptions(v *AwsOpenSearchServiceDomainMasterUserOptionsDetails) *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails

SetMasterUserOptions sets the MasterUserOptions field's value.

func (AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) String added in v1.44.36 

func (s AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainClusterConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterCount(v int64) *AwsOpenSearchServiceDomainClusterConfigDetails

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterEnabled added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterEnabled(v bool) *AwsOpenSearchServiceDomainClusterConfigDetails

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterType added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterType(v string) *AwsOpenSearchServiceDomainClusterConfigDetails

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetInstanceCount added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetInstanceCount(v int64) *AwsOpenSearchServiceDomainClusterConfigDetails

SetInstanceCount sets the InstanceCount field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetInstanceType added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetInstanceType(v string) *AwsOpenSearchServiceDomainClusterConfigDetails

SetInstanceType sets the InstanceType field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmCount added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmCount(v int64) *AwsOpenSearchServiceDomainClusterConfigDetails

SetWarmCount sets the WarmCount field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmEnabled added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmEnabled(v bool) *AwsOpenSearchServiceDomainClusterConfigDetails

SetWarmEnabled sets the WarmEnabled field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmType added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmType(v string) *AwsOpenSearchServiceDomainClusterConfigDetails

SetWarmType sets the WarmType field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetZoneAwarenessConfig added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetZoneAwarenessConfig(v *AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) *AwsOpenSearchServiceDomainClusterConfigDetails

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetZoneAwarenessEnabled added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigDetails) SetZoneAwarenessEnabled(v bool) *AwsOpenSearchServiceDomainClusterConfigDetails

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (AwsOpenSearchServiceDomainClusterConfigDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainClusterConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) SetAvailabilityZoneCount(v int64) *AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetAccessPolicies(v string) *AwsOpenSearchServiceDomainDetails

SetAccessPolicies sets the AccessPolicies field's value.

func (*AwsOpenSearchServiceDomainDetails) SetAdvancedSecurityOptions added in v1.44.36 

func (s *AwsOpenSearchServiceDomainDetails) SetAdvancedSecurityOptions(v *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetArn added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetArn(v string) *AwsOpenSearchServiceDomainDetails

SetArn sets the Arn field's value.

func (*AwsOpenSearchServiceDomainDetails) SetClusterConfig added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetClusterConfig(v *AwsOpenSearchServiceDomainClusterConfigDetails) *AwsOpenSearchServiceDomainDetails

SetClusterConfig sets the ClusterConfig field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainEndpoint added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetDomainEndpoint(v string) *AwsOpenSearchServiceDomainDetails

SetDomainEndpoint sets the DomainEndpoint field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainEndpointOptions added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetDomainEndpointOptions(v *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainEndpoints added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetDomainEndpoints(v map[string]*string) *AwsOpenSearchServiceDomainDetails

SetDomainEndpoints sets the DomainEndpoints field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainName added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetDomainName(v string) *AwsOpenSearchServiceDomainDetails

SetDomainName sets the DomainName field's value.

func (*AwsOpenSearchServiceDomainDetails) SetEncryptionAtRestOptions added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetEncryptionAtRestOptions(v *AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetEngineVersion added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetEngineVersion(v string) *AwsOpenSearchServiceDomainDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsOpenSearchServiceDomainDetails) SetId added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetId(v string) *AwsOpenSearchServiceDomainDetails

SetId sets the Id field's value.

func (*AwsOpenSearchServiceDomainDetails) SetLogPublishingOptions added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetLogPublishingOptions(v *AwsOpenSearchServiceDomainLogPublishingOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetNodeToNodeEncryptionOptions added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetNodeToNodeEncryptionOptions(v *AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetServiceSoftwareOptions added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetServiceSoftwareOptions(v *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetVpcOptions added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDetails) SetVpcOptions(v *AwsOpenSearchServiceDomainVpcOptionsDetails) *AwsOpenSearchServiceDomainDetails

SetVpcOptions sets the VpcOptions field's value.

func (AwsOpenSearchServiceDomainDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpoint(v string) *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

SetCustomEndpoint sets the CustomEndpoint field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpointCertificateArn added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpointCertificateArn(v string) *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

SetCustomEndpointCertificateArn sets the CustomEndpointCertificateArn field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpointEnabled added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpointEnabled(v bool) *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

SetCustomEndpointEnabled sets the CustomEndpointEnabled field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetEnforceHTTPS added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetEnforceHTTPS(v bool) *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetTLSSecurityPolicy added in v1.40.59 

func (s *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetTLSSecurityPolicy(v string) *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) SetEnabled(v bool) *AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails

SetEnabled sets the Enabled field's value.

func (*AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) SetKmsKeyId added in v1.40.59 

func (s *AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) SetKmsKeyId(v string) *AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainLogPublishingOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainLogPublishingOption) SetCloudWatchLogsLogGroupArn(v string) *AwsOpenSearchServiceDomainLogPublishingOption

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*AwsOpenSearchServiceDomainLogPublishingOption) SetEnabled added in v1.40.59 

func (s *AwsOpenSearchServiceDomainLogPublishingOption) SetEnabled(v bool) *AwsOpenSearchServiceDomainLogPublishingOption

SetEnabled sets the Enabled field's value.

func (AwsOpenSearchServiceDomainLogPublishingOption) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainLogPublishingOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainLogPublishingOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetAuditLogs(v *AwsOpenSearchServiceDomainLogPublishingOption) *AwsOpenSearchServiceDomainLogPublishingOptionsDetails

SetAuditLogs sets the AuditLogs field's value.

func (*AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetIndexSlowLogs added in v1.40.59 

func (s *AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetIndexSlowLogs(v *AwsOpenSearchServiceDomainLogPublishingOption) *AwsOpenSearchServiceDomainLogPublishingOptionsDetails

SetIndexSlowLogs sets the IndexSlowLogs field's value.

func (*AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetSearchSlowLogs added in v1.40.59 

func (s *AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetSearchSlowLogs(v *AwsOpenSearchServiceDomainLogPublishingOption) *AwsOpenSearchServiceDomainLogPublishingOptionsDetails

SetSearchSlowLogs sets the SearchSlowLogs field's value.

func (AwsOpenSearchServiceDomainLogPublishingOptionsDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainLogPublishingOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsOpenSearchServiceDomainMasterUserOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserArn(v string) *AwsOpenSearchServiceDomainMasterUserOptionsDetails

SetMasterUserArn sets the MasterUserArn field's value.

func (*AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserName added in v1.44.36 

func (s *AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserName(v string) *AwsOpenSearchServiceDomainMasterUserOptionsDetails

SetMasterUserName sets the MasterUserName field's value.

func (*AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserPassword added in v1.44.36 

func (s *AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserPassword(v string) *AwsOpenSearchServiceDomainMasterUserOptionsDetails

SetMasterUserPassword sets the MasterUserPassword field's value.

func (AwsOpenSearchServiceDomainMasterUserOptionsDetails) String added in v1.44.36 

func (s AwsOpenSearchServiceDomainMasterUserOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) SetEnabled(v bool) *AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails

SetEnabled sets the Enabled field's value.

func (AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetAutomatedUpdateDate(v string) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetCancellable added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetCancellable(v bool) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetCancellable sets the Cancellable field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetCurrentVersion added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetCurrentVersion(v string) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetCurrentVersion sets the CurrentVersion field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetDescription added in v1.40.59 

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

SetDescription sets the Description field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetNewVersion added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetNewVersion(v string) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetNewVersion sets the NewVersion field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetOptionalDeployment added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetOptionalDeployment(v bool) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetOptionalDeployment sets the OptionalDeployment field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetUpdateAvailable added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetUpdateAvailable(v bool) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetUpdateAvailable sets the UpdateAvailable field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetUpdateStatus added in v1.40.59 

func (s *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetUpdateStatus(v string) *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

SetUpdateStatus sets the UpdateStatus field's value.

func (AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsOpenSearchServiceDomainVpcOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsOpenSearchServiceDomainVpcOptionsDetails) SetSecurityGroupIds(v []*string) *AwsOpenSearchServiceDomainVpcOptionsDetails

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsOpenSearchServiceDomainVpcOptionsDetails) SetSubnetIds added in v1.40.59 

func (s *AwsOpenSearchServiceDomainVpcOptionsDetails) SetSubnetIds(v []*string) *AwsOpenSearchServiceDomainVpcOptionsDetails

SetSubnetIds sets the SubnetIds field's value.

func (AwsOpenSearchServiceDomainVpcOptionsDetails) String added in v1.40.59 

func (s AwsOpenSearchServiceDomainVpcOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsRdsDbClusterAssociatedRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsRdsDbClusterAssociatedRole) SetRoleArn(v string) *AwsRdsDbClusterAssociatedRole

SetRoleArn sets the RoleArn field's value.

func (*AwsRdsDbClusterAssociatedRole) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (AwsRdsDbClusterAssociatedRole) String added in v1.34.7 

func (s AwsRdsDbClusterAssociatedRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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"`

	// Indicates if minor version upgrades are automatically applied to the cluster.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// 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).
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetActivityStreamStatus(v string) *AwsRdsDbClusterDetails

SetActivityStreamStatus sets the ActivityStreamStatus field's value.

func (*AwsRdsDbClusterDetails) SetAllocatedStorage added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbClusterDetails) SetAssociatedRoles added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetAssociatedRoles(v []*AwsRdsDbClusterAssociatedRole) *AwsRdsDbClusterDetails

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*AwsRdsDbClusterDetails) SetAutoMinorVersionUpgrade added in v1.45.23 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*AwsRdsDbClusterDetails) SetAvailabilityZones added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsRdsDbClusterDetails) SetBackupRetentionPeriod added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbClusterDetails

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*AwsRdsDbClusterDetails) SetClusterCreateTime added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterDetails

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*AwsRdsDbClusterDetails) SetCopyTagsToSnapshot added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbClusterDetails

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*AwsRdsDbClusterDetails) SetCrossAccountClone added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetCrossAccountClone(v bool) *AwsRdsDbClusterDetails

SetCrossAccountClone sets the CrossAccountClone field's value.

func (*AwsRdsDbClusterDetails) SetCustomEndpoints added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetCustomEndpoints(v []*string) *AwsRdsDbClusterDetails

SetCustomEndpoints sets the CustomEndpoints field's value.

func (*AwsRdsDbClusterDetails) SetDatabaseName added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDatabaseName(v string) *AwsRdsDbClusterDetails

SetDatabaseName sets the DatabaseName field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterIdentifier added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterDetails

SetDbClusterIdentifier sets the DbClusterIdentifier field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterMembers added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDbClusterMembers(v []*AwsRdsDbClusterMember) *AwsRdsDbClusterDetails

SetDbClusterMembers sets the DbClusterMembers field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterOptionGroupMemberships added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDbClusterOptionGroupMemberships(v []*AwsRdsDbClusterOptionGroupMembership) *AwsRdsDbClusterDetails

SetDbClusterOptionGroupMemberships sets the DbClusterOptionGroupMemberships field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterParameterGroup added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDbClusterParameterGroup(v string) *AwsRdsDbClusterDetails

SetDbClusterParameterGroup sets the DbClusterParameterGroup field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterResourceId added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDbClusterResourceId(v string) *AwsRdsDbClusterDetails

SetDbClusterResourceId sets the DbClusterResourceId field's value.

func (*AwsRdsDbClusterDetails) SetDbSubnetGroup added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDbSubnetGroup(v string) *AwsRdsDbClusterDetails

SetDbSubnetGroup sets the DbSubnetGroup field's value.

func (*AwsRdsDbClusterDetails) SetDeletionProtection added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDeletionProtection(v bool) *AwsRdsDbClusterDetails

SetDeletionProtection sets the DeletionProtection field's value.

func (*AwsRdsDbClusterDetails) SetDomainMemberships added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetDomainMemberships(v []*AwsRdsDbDomainMembership) *AwsRdsDbClusterDetails

SetDomainMemberships sets the DomainMemberships field's value.

func (*AwsRdsDbClusterDetails) SetEnabledCloudWatchLogsExports added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbClusterDetails

SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.

func (*AwsRdsDbClusterDetails) SetEndpoint added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetEndpoint(v string) *AwsRdsDbClusterDetails

SetEndpoint sets the Endpoint field's value.

func (*AwsRdsDbClusterDetails) SetEngine added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetEngine(v string) *AwsRdsDbClusterDetails

SetEngine sets the Engine field's value.

func (*AwsRdsDbClusterDetails) SetEngineMode added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetEngineMode(v string) *AwsRdsDbClusterDetails

SetEngineMode sets the EngineMode field's value.

func (*AwsRdsDbClusterDetails) SetEngineVersion added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetEngineVersion(v string) *AwsRdsDbClusterDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbClusterDetails) SetHostedZoneId added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetHostedZoneId(v string) *AwsRdsDbClusterDetails

SetHostedZoneId sets the HostedZoneId field's value.

func (*AwsRdsDbClusterDetails) SetHttpEndpointEnabled added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetHttpEndpointEnabled(v bool) *AwsRdsDbClusterDetails

SetHttpEndpointEnabled sets the HttpEndpointEnabled field's value.

func (*AwsRdsDbClusterDetails) SetIamDatabaseAuthenticationEnabled added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterDetails

SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbClusterDetails) SetKmsKeyId added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetKmsKeyId(v string) *AwsRdsDbClusterDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbClusterDetails) SetMasterUsername added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetMasterUsername(v string) *AwsRdsDbClusterDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbClusterDetails) SetMultiAz added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetMultiAz(v bool) *AwsRdsDbClusterDetails

SetMultiAz sets the MultiAz field's value.

func (*AwsRdsDbClusterDetails) SetPort added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetPort(v int64) *AwsRdsDbClusterDetails

SetPort sets the Port field's value.

func (*AwsRdsDbClusterDetails) SetPreferredBackupWindow added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetPreferredBackupWindow(v string) *AwsRdsDbClusterDetails

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*AwsRdsDbClusterDetails) SetPreferredMaintenanceWindow added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbClusterDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsRdsDbClusterDetails) SetReadReplicaIdentifiers added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetReadReplicaIdentifiers(v []*string) *AwsRdsDbClusterDetails

SetReadReplicaIdentifiers sets the ReadReplicaIdentifiers field's value.

func (*AwsRdsDbClusterDetails) SetReaderEndpoint added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetReaderEndpoint(v string) *AwsRdsDbClusterDetails

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*AwsRdsDbClusterDetails) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (*AwsRdsDbClusterDetails) SetStorageEncrypted added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterDetails

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*AwsRdsDbClusterDetails) SetVpcSecurityGroups added in v1.34.7 

func (s *AwsRdsDbClusterDetails) SetVpcSecurityGroups(v []*AwsRdsDbInstanceVpcSecurityGroup) *AwsRdsDbClusterDetails

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsRdsDbClusterDetails) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbClusterMember) SetDbClusterParameterGroupStatus(v string) *AwsRdsDbClusterMember

SetDbClusterParameterGroupStatus sets the DbClusterParameterGroupStatus field's value.

func (*AwsRdsDbClusterMember) SetDbInstanceIdentifier added in v1.34.7 

func (s *AwsRdsDbClusterMember) SetDbInstanceIdentifier(v string) *AwsRdsDbClusterMember

SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.

func (*AwsRdsDbClusterMember) SetIsClusterWriter added in v1.34.7 

func (s *AwsRdsDbClusterMember) SetIsClusterWriter(v bool) *AwsRdsDbClusterMember

SetIsClusterWriter sets the IsClusterWriter field's value.

func (*AwsRdsDbClusterMember) SetPromotionTier added in v1.34.7 

func (s *AwsRdsDbClusterMember) SetPromotionTier(v int64) *AwsRdsDbClusterMember

SetPromotionTier sets the PromotionTier field's value.

func (AwsRdsDbClusterMember) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsRdsDbClusterOptionGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsRdsDbClusterOptionGroupMembership) SetDbClusterOptionGroupName(v string) *AwsRdsDbClusterOptionGroupMembership

SetDbClusterOptionGroupName sets the DbClusterOptionGroupName field's value.

func (*AwsRdsDbClusterOptionGroupMembership) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (AwsRdsDbClusterOptionGroupMembership) String added in v1.34.7 

func (s AwsRdsDbClusterOptionGroupMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

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.44.308 

func (s AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.308 

func (s *AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) SetAttributeName(v string) *AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute

SetAttributeName sets the AttributeName field's value.

func (*AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) SetAttributeValues added in v1.44.308 

func (s *AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) SetAttributeValues(v []*string) *AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute

SetAttributeValues sets the AttributeValues field's value.

func (AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) String added in v1.44.308 

func (s AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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).
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.7 

func (s AwsRdsDbClusterSnapshotDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterSnapshotDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetAvailabilityZones added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterSnapshotDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetClusterCreateTime added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterSnapshotDetails

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetDbClusterIdentifier added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterSnapshotDetails

SetDbClusterIdentifier sets the DbClusterIdentifier field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotAttributes added in v1.44.308 

func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotAttributes(v []*AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) *AwsRdsDbClusterSnapshotDetails

SetDbClusterSnapshotAttributes sets the DbClusterSnapshotAttributes field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotIdentifier added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotIdentifier(v string) *AwsRdsDbClusterSnapshotDetails

SetDbClusterSnapshotIdentifier sets the DbClusterSnapshotIdentifier field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetEngine added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetEngine(v string) *AwsRdsDbClusterSnapshotDetails

SetEngine sets the Engine field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetEngineVersion added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbClusterSnapshotDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetIamDatabaseAuthenticationEnabled added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterSnapshotDetails

SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetKmsKeyId added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetKmsKeyId(v string) *AwsRdsDbClusterSnapshotDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetLicenseModel added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetLicenseModel(v string) *AwsRdsDbClusterSnapshotDetails

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetMasterUsername added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbClusterSnapshotDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetPercentProgress added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbClusterSnapshotDetails

SetPercentProgress sets the PercentProgress field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetPort added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetPort(v int64) *AwsRdsDbClusterSnapshotDetails

SetPort sets the Port field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetSnapshotCreateTime added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbClusterSnapshotDetails

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetSnapshotType added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetSnapshotType(v string) *AwsRdsDbClusterSnapshotDetails

SetSnapshotType sets the SnapshotType field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetStorageEncrypted added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterSnapshotDetails

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetVpcId added in v1.34.7 

func (s *AwsRdsDbClusterSnapshotDetails) SetVpcId(v string) *AwsRdsDbClusterSnapshotDetails

SetVpcId sets the VpcId field's value.

func (AwsRdsDbClusterSnapshotDetails) String added in v1.34.7 

func (s AwsRdsDbClusterSnapshotDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbDomainMembership) SetDomain(v string) *AwsRdsDbDomainMembership

SetDomain sets the Domain field's value.

func (*AwsRdsDbDomainMembership) SetFqdn added in v1.34.7 

func (s *AwsRdsDbDomainMembership) SetFqdn(v string) *AwsRdsDbDomainMembership

SetFqdn sets the Fqdn field's value.

func (*AwsRdsDbDomainMembership) SetIamRoleName added in v1.34.7 

func (s *AwsRdsDbDomainMembership) SetIamRoleName(v string) *AwsRdsDbDomainMembership

SetIamRoleName sets the IamRoleName field's value.

func (*AwsRdsDbDomainMembership) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (AwsRdsDbDomainMembership) String added in v1.34.7 

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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsRdsDbInstanceAssociatedRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

func (s *AwsRdsDbInstanceAssociatedRole) SetFeatureName(v string) *AwsRdsDbInstanceAssociatedRole

SetFeatureName sets the FeatureName field's value.

func (*AwsRdsDbInstanceAssociatedRole) SetRoleArn added in v1.28.11 

func (s *AwsRdsDbInstanceAssociatedRole) SetRoleArn(v string) *AwsRdsDbInstanceAssociatedRole

SetRoleArn sets the RoleArn field's value.

func (*AwsRdsDbInstanceAssociatedRole) SetStatus added in v1.28.11 

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

SetStatus sets the Status field's value.

func (AwsRdsDbInstanceAssociatedRole) String added in v1.28.11 

func (s AwsRdsDbInstanceAssociatedRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.28.11 

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 added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetAllocatedStorage(v int64) *AwsRdsDbInstanceDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbInstanceDetails) SetAssociatedRoles added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetAssociatedRoles(v []*AwsRdsDbInstanceAssociatedRole) *AwsRdsDbInstanceDetails

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*AwsRdsDbInstanceDetails) SetAutoMinorVersionUpgrade added in v1.34.7 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*AwsRdsDbInstanceDetails) SetAvailabilityZone added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetAvailabilityZone(v string) *AwsRdsDbInstanceDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsRdsDbInstanceDetails) SetBackupRetentionPeriod added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbInstanceDetails

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*AwsRdsDbInstanceDetails) SetCACertificateIdentifier added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetCACertificateIdentifier(v string) *AwsRdsDbInstanceDetails

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetCharacterSetName added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetCharacterSetName(v string) *AwsRdsDbInstanceDetails

SetCharacterSetName sets the CharacterSetName field's value.

func (*AwsRdsDbInstanceDetails) SetCopyTagsToSnapshot added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbInstanceDetails

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*AwsRdsDbInstanceDetails) SetDBClusterIdentifier added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDBClusterIdentifier(v string) *AwsRdsDbInstanceDetails

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetDBInstanceClass added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDBInstanceClass(v string) *AwsRdsDbInstanceDetails

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*AwsRdsDbInstanceDetails) SetDBInstanceIdentifier added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetDBName added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDBName(v string) *AwsRdsDbInstanceDetails

SetDBName sets the DBName field's value.

func (*AwsRdsDbInstanceDetails) SetDbInstancePort added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDbInstancePort(v int64) *AwsRdsDbInstanceDetails

SetDbInstancePort sets the DbInstancePort field's value.

func (*AwsRdsDbInstanceDetails) SetDbInstanceStatus added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetDbInstanceStatus(v string) *AwsRdsDbInstanceDetails

SetDbInstanceStatus sets the DbInstanceStatus field's value.

func (*AwsRdsDbInstanceDetails) SetDbParameterGroups added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetDbParameterGroups(v []*AwsRdsDbParameterGroup) *AwsRdsDbInstanceDetails

SetDbParameterGroups sets the DbParameterGroups field's value.

func (*AwsRdsDbInstanceDetails) SetDbSecurityGroups added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetDbSecurityGroups(v []*string) *AwsRdsDbInstanceDetails

SetDbSecurityGroups sets the DbSecurityGroups field's value.

func (*AwsRdsDbInstanceDetails) SetDbSubnetGroup added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetDbSubnetGroup(v *AwsRdsDbSubnetGroup) *AwsRdsDbInstanceDetails

SetDbSubnetGroup sets the DbSubnetGroup field's value.

func (*AwsRdsDbInstanceDetails) SetDbiResourceId added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDbiResourceId(v string) *AwsRdsDbInstanceDetails

SetDbiResourceId sets the DbiResourceId field's value.

func (*AwsRdsDbInstanceDetails) SetDeletionProtection added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetDeletionProtection(v bool) *AwsRdsDbInstanceDetails

SetDeletionProtection sets the DeletionProtection field's value.

func (*AwsRdsDbInstanceDetails) SetDomainMemberships added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetDomainMemberships(v []*AwsRdsDbDomainMembership) *AwsRdsDbInstanceDetails

SetDomainMemberships sets the DomainMemberships field's value.

func (*AwsRdsDbInstanceDetails) SetEnabledCloudWatchLogsExports added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbInstanceDetails

SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.

func (*AwsRdsDbInstanceDetails) SetEndpoint added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetEndpoint(v *AwsRdsDbInstanceEndpoint) *AwsRdsDbInstanceDetails

SetEndpoint sets the Endpoint field's value.

func (*AwsRdsDbInstanceDetails) SetEngine added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetEngine(v string) *AwsRdsDbInstanceDetails

SetEngine sets the Engine field's value.

func (*AwsRdsDbInstanceDetails) SetEngineVersion added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetEngineVersion(v string) *AwsRdsDbInstanceDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbInstanceDetails) SetEnhancedMonitoringResourceArn added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetEnhancedMonitoringResourceArn(v string) *AwsRdsDbInstanceDetails

SetEnhancedMonitoringResourceArn sets the EnhancedMonitoringResourceArn field's value.

func (*AwsRdsDbInstanceDetails) SetIAMDatabaseAuthenticationEnabled added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetIAMDatabaseAuthenticationEnabled(v bool) *AwsRdsDbInstanceDetails

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbInstanceDetails) SetInstanceCreateTime added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetInstanceCreateTime(v string) *AwsRdsDbInstanceDetails

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*AwsRdsDbInstanceDetails) SetIops added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetIops(v int64) *AwsRdsDbInstanceDetails

SetIops sets the Iops field's value.

func (*AwsRdsDbInstanceDetails) SetKmsKeyId added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetKmsKeyId(v string) *AwsRdsDbInstanceDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbInstanceDetails) SetLatestRestorableTime added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetLatestRestorableTime(v string) *AwsRdsDbInstanceDetails

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*AwsRdsDbInstanceDetails) SetLicenseModel added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetLicenseModel(v string) *AwsRdsDbInstanceDetails

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbInstanceDetails) SetListenerEndpoint added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetListenerEndpoint(v *AwsRdsDbInstanceEndpoint) *AwsRdsDbInstanceDetails

SetListenerEndpoint sets the ListenerEndpoint field's value.

func (*AwsRdsDbInstanceDetails) SetMasterUsername added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetMasterUsername(v string) *AwsRdsDbInstanceDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbInstanceDetails) SetMaxAllocatedStorage added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetMaxAllocatedStorage(v int64) *AwsRdsDbInstanceDetails

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*AwsRdsDbInstanceDetails) SetMonitoringInterval added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetMonitoringInterval(v int64) *AwsRdsDbInstanceDetails

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*AwsRdsDbInstanceDetails) SetMonitoringRoleArn added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetMonitoringRoleArn(v string) *AwsRdsDbInstanceDetails

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*AwsRdsDbInstanceDetails) SetMultiAz added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetMultiAz(v bool) *AwsRdsDbInstanceDetails

SetMultiAz sets the MultiAz field's value.

func (*AwsRdsDbInstanceDetails) SetOptionGroupMemberships added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetOptionGroupMemberships(v []*AwsRdsDbOptionGroupMembership) *AwsRdsDbInstanceDetails

SetOptionGroupMemberships sets the OptionGroupMemberships field's value.

func (*AwsRdsDbInstanceDetails) SetPendingModifiedValues added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPendingModifiedValues(v *AwsRdsDbPendingModifiedValues) *AwsRdsDbInstanceDetails

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*AwsRdsDbInstanceDetails) SetPerformanceInsightsEnabled added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsEnabled(v bool) *AwsRdsDbInstanceDetails

SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.

func (*AwsRdsDbInstanceDetails) SetPerformanceInsightsKmsKeyId added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsKmsKeyId(v string) *AwsRdsDbInstanceDetails

SetPerformanceInsightsKmsKeyId sets the PerformanceInsightsKmsKeyId field's value.

func (*AwsRdsDbInstanceDetails) SetPerformanceInsightsRetentionPeriod added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsRetentionPeriod(v int64) *AwsRdsDbInstanceDetails

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*AwsRdsDbInstanceDetails) SetPreferredBackupWindow added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPreferredBackupWindow(v string) *AwsRdsDbInstanceDetails

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*AwsRdsDbInstanceDetails) SetPreferredMaintenanceWindow added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbInstanceDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsRdsDbInstanceDetails) SetProcessorFeatures added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbInstanceDetails

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*AwsRdsDbInstanceDetails) SetPromotionTier added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetPromotionTier(v int64) *AwsRdsDbInstanceDetails

SetPromotionTier sets the PromotionTier field's value.

func (*AwsRdsDbInstanceDetails) SetPubliclyAccessible added in v1.28.11 

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsRdsDbInstanceDetails) SetReadReplicaDBClusterIdentifiers added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBClusterIdentifiers(v []*string) *AwsRdsDbInstanceDetails

SetReadReplicaDBClusterIdentifiers sets the ReadReplicaDBClusterIdentifiers field's value.

func (*AwsRdsDbInstanceDetails) SetReadReplicaDBInstanceIdentifiers added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBInstanceIdentifiers(v []*string) *AwsRdsDbInstanceDetails

SetReadReplicaDBInstanceIdentifiers sets the ReadReplicaDBInstanceIdentifiers field's value.

func (*AwsRdsDbInstanceDetails) SetReadReplicaSourceDBInstanceIdentifier added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetReadReplicaSourceDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails

SetReadReplicaSourceDBInstanceIdentifier sets the ReadReplicaSourceDBInstanceIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetSecondaryAvailabilityZone added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetSecondaryAvailabilityZone(v string) *AwsRdsDbInstanceDetails

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*AwsRdsDbInstanceDetails) SetStatusInfos added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetStatusInfos(v []*AwsRdsDbStatusInfo) *AwsRdsDbInstanceDetails

SetStatusInfos sets the StatusInfos field's value.

func (*AwsRdsDbInstanceDetails) SetStorageEncrypted added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetStorageEncrypted(v bool) *AwsRdsDbInstanceDetails

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*AwsRdsDbInstanceDetails) SetStorageType added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetStorageType(v string) *AwsRdsDbInstanceDetails

SetStorageType sets the StorageType field's value.

func (*AwsRdsDbInstanceDetails) SetTdeCredentialArn added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetTdeCredentialArn(v string) *AwsRdsDbInstanceDetails

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*AwsRdsDbInstanceDetails) SetTimezone added in v1.34.7 

func (s *AwsRdsDbInstanceDetails) SetTimezone(v string) *AwsRdsDbInstanceDetails

SetTimezone sets the Timezone field's value.

func (*AwsRdsDbInstanceDetails) SetVpcSecurityGroups added in v1.28.11 

func (s *AwsRdsDbInstanceDetails) SetVpcSecurityGroups(v []*AwsRdsDbInstanceVpcSecurityGroup) *AwsRdsDbInstanceDetails

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsRdsDbInstanceDetails) String added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsRdsDbInstanceEndpoint) SetAddress(v string) *AwsRdsDbInstanceEndpoint

SetAddress sets the Address field's value.

func (*AwsRdsDbInstanceEndpoint) SetHostedZoneId added in v1.28.11 

func (s *AwsRdsDbInstanceEndpoint) SetHostedZoneId(v string) *AwsRdsDbInstanceEndpoint

SetHostedZoneId sets the HostedZoneId field's value.

func (*AwsRdsDbInstanceEndpoint) SetPort added in v1.28.11 

func (s *AwsRdsDbInstanceEndpoint) SetPort(v int64) *AwsRdsDbInstanceEndpoint

SetPort sets the Port field's value.

func (AwsRdsDbInstanceEndpoint) String added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s AwsRdsDbInstanceVpcSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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

SetStatus sets the Status field's value.

func (*AwsRdsDbInstanceVpcSecurityGroup) SetVpcSecurityGroupId added in v1.28.11 

func (s *AwsRdsDbInstanceVpcSecurityGroup) SetVpcSecurityGroupId(v string) *AwsRdsDbInstanceVpcSecurityGroup

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (AwsRdsDbInstanceVpcSecurityGroup) String added in v1.28.11 

func (s AwsRdsDbInstanceVpcSecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsRdsDbOptionGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsRdsDbOptionGroupMembership) SetOptionGroupName(v string) *AwsRdsDbOptionGroupMembership

SetOptionGroupName sets the OptionGroupName field's value.

func (*AwsRdsDbOptionGroupMembership) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (AwsRdsDbOptionGroupMembership) String added in v1.34.7 

func (s AwsRdsDbOptionGroupMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbParameterGroup) SetDbParameterGroupName(v string) *AwsRdsDbParameterGroup

SetDbParameterGroupName sets the DbParameterGroupName field's value.

func (*AwsRdsDbParameterGroup) SetParameterApplyStatus added in v1.34.7 

func (s *AwsRdsDbParameterGroup) SetParameterApplyStatus(v string) *AwsRdsDbParameterGroup

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (AwsRdsDbParameterGroup) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsRdsDbPendingModifiedValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetAllocatedStorage(v int64) *AwsRdsDbPendingModifiedValues

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbPendingModifiedValues) SetBackupRetentionPeriod added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetBackupRetentionPeriod(v int64) *AwsRdsDbPendingModifiedValues

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*AwsRdsDbPendingModifiedValues) SetCaCertificateIdentifier added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetCaCertificateIdentifier(v string) *AwsRdsDbPendingModifiedValues

SetCaCertificateIdentifier sets the CaCertificateIdentifier field's value.

func (*AwsRdsDbPendingModifiedValues) SetDbInstanceClass added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetDbInstanceClass(v string) *AwsRdsDbPendingModifiedValues

SetDbInstanceClass sets the DbInstanceClass field's value.

func (*AwsRdsDbPendingModifiedValues) SetDbInstanceIdentifier added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetDbInstanceIdentifier(v string) *AwsRdsDbPendingModifiedValues

SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.

func (*AwsRdsDbPendingModifiedValues) SetDbSubnetGroupName added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetDbSubnetGroupName(v string) *AwsRdsDbPendingModifiedValues

SetDbSubnetGroupName sets the DbSubnetGroupName field's value.

func (*AwsRdsDbPendingModifiedValues) SetEngineVersion added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetEngineVersion(v string) *AwsRdsDbPendingModifiedValues

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbPendingModifiedValues) SetIops added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetIops(v int64) *AwsRdsDbPendingModifiedValues

SetIops sets the Iops field's value.

func (*AwsRdsDbPendingModifiedValues) SetLicenseModel added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetLicenseModel(v string) *AwsRdsDbPendingModifiedValues

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbPendingModifiedValues) SetMasterUserPassword added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetMasterUserPassword(v string) *AwsRdsDbPendingModifiedValues

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*AwsRdsDbPendingModifiedValues) SetMultiAZ added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetMultiAZ(v bool) *AwsRdsDbPendingModifiedValues

SetMultiAZ sets the MultiAZ field's value.

func (*AwsRdsDbPendingModifiedValues) SetPendingCloudWatchLogsExports added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetPendingCloudWatchLogsExports(v *AwsRdsPendingCloudWatchLogsExports) *AwsRdsDbPendingModifiedValues

SetPendingCloudWatchLogsExports sets the PendingCloudWatchLogsExports field's value.

func (*AwsRdsDbPendingModifiedValues) SetPort added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetPort(v int64) *AwsRdsDbPendingModifiedValues

SetPort sets the Port field's value.

func (*AwsRdsDbPendingModifiedValues) SetProcessorFeatures added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbPendingModifiedValues

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*AwsRdsDbPendingModifiedValues) SetStorageType added in v1.34.7 

func (s *AwsRdsDbPendingModifiedValues) SetStorageType(v string) *AwsRdsDbPendingModifiedValues

SetStorageType sets the StorageType field's value.

func (AwsRdsDbPendingModifiedValues) String added in v1.34.7 

func (s AwsRdsDbPendingModifiedValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

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

SetName sets the Name field's value.

func (*AwsRdsDbProcessorFeature) SetValue added in v1.34.7 

func (s *AwsRdsDbProcessorFeature) SetValue(v string) *AwsRdsDbProcessorFeature

SetValue sets the Value field's value.

func (AwsRdsDbProcessorFeature) String added in v1.34.7 

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.43.33 

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.43.33 

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.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupArn(v string) *AwsRdsDbSecurityGroupDetails

SetDbSecurityGroupArn sets the DbSecurityGroupArn field's value.

func (*AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupDescription added in v1.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupDescription(v string) *AwsRdsDbSecurityGroupDetails

SetDbSecurityGroupDescription sets the DbSecurityGroupDescription field's value.

func (*AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupName added in v1.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupName(v string) *AwsRdsDbSecurityGroupDetails

SetDbSecurityGroupName sets the DbSecurityGroupName field's value.

func (*AwsRdsDbSecurityGroupDetails) SetEc2SecurityGroups added in v1.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetEc2SecurityGroups(v []*AwsRdsDbSecurityGroupEc2SecurityGroup) *AwsRdsDbSecurityGroupDetails

SetEc2SecurityGroups sets the Ec2SecurityGroups field's value.

func (*AwsRdsDbSecurityGroupDetails) SetIpRanges added in v1.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetIpRanges(v []*AwsRdsDbSecurityGroupIpRange) *AwsRdsDbSecurityGroupDetails

SetIpRanges sets the IpRanges field's value.

func (*AwsRdsDbSecurityGroupDetails) SetOwnerId added in v1.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetOwnerId(v string) *AwsRdsDbSecurityGroupDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsRdsDbSecurityGroupDetails) SetVpcId added in v1.43.33 

func (s *AwsRdsDbSecurityGroupDetails) SetVpcId(v string) *AwsRdsDbSecurityGroupDetails

SetVpcId sets the VpcId field's value.

func (AwsRdsDbSecurityGroupDetails) String added in v1.43.33 

func (s AwsRdsDbSecurityGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

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.43.33 

func (s AwsRdsDbSecurityGroupEc2SecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

func (s *AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupId(v string) *AwsRdsDbSecurityGroupEc2SecurityGroup

SetEc2SecurityGroupId sets the Ec2SecurityGroupId field's value.

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupName added in v1.43.33 

func (s *AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupName(v string) *AwsRdsDbSecurityGroupEc2SecurityGroup

SetEc2SecurityGroupName sets the Ec2SecurityGroupName field's value.

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupOwnerId added in v1.43.33 

func (s *AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupOwnerId(v string) *AwsRdsDbSecurityGroupEc2SecurityGroup

SetEc2SecurityGroupOwnerId sets the Ec2SecurityGroupOwnerId field's value.

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetStatus added in v1.43.33 

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

SetStatus sets the Status field's value.

func (AwsRdsDbSecurityGroupEc2SecurityGroup) String added in v1.43.33 

func (s AwsRdsDbSecurityGroupEc2SecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

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.43.33 

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.43.33 

func (s *AwsRdsDbSecurityGroupIpRange) SetCidrIp(v string) *AwsRdsDbSecurityGroupIpRange

SetCidrIp sets the CidrIp field's value.

func (*AwsRdsDbSecurityGroupIpRange) SetStatus added in v1.43.33 

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

SetStatus sets the Status field's value.

func (AwsRdsDbSecurityGroupIpRange) String added in v1.43.33 

func (s AwsRdsDbSecurityGroupIpRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbSnapshotDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbSnapshotDetails) SetAvailabilityZone added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetAvailabilityZone(v string) *AwsRdsDbSnapshotDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsRdsDbSnapshotDetails) SetDbInstanceIdentifier added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetDbInstanceIdentifier(v string) *AwsRdsDbSnapshotDetails

SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.

func (*AwsRdsDbSnapshotDetails) SetDbSnapshotIdentifier added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails

SetDbSnapshotIdentifier sets the DbSnapshotIdentifier field's value.

func (*AwsRdsDbSnapshotDetails) SetDbiResourceId added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetDbiResourceId(v string) *AwsRdsDbSnapshotDetails

SetDbiResourceId sets the DbiResourceId field's value.

func (*AwsRdsDbSnapshotDetails) SetEncrypted added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetEncrypted(v bool) *AwsRdsDbSnapshotDetails

SetEncrypted sets the Encrypted field's value.

func (*AwsRdsDbSnapshotDetails) SetEngine added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetEngine(v string) *AwsRdsDbSnapshotDetails

SetEngine sets the Engine field's value.

func (*AwsRdsDbSnapshotDetails) SetEngineVersion added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbSnapshotDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbSnapshotDetails) SetIamDatabaseAuthenticationEnabled added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbSnapshotDetails

SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbSnapshotDetails) SetInstanceCreateTime added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetInstanceCreateTime(v string) *AwsRdsDbSnapshotDetails

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*AwsRdsDbSnapshotDetails) SetIops added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetIops(v int64) *AwsRdsDbSnapshotDetails

SetIops sets the Iops field's value.

func (*AwsRdsDbSnapshotDetails) SetKmsKeyId added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetKmsKeyId(v string) *AwsRdsDbSnapshotDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbSnapshotDetails) SetLicenseModel added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetLicenseModel(v string) *AwsRdsDbSnapshotDetails

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbSnapshotDetails) SetMasterUsername added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbSnapshotDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbSnapshotDetails) SetOptionGroupName added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetOptionGroupName(v string) *AwsRdsDbSnapshotDetails

SetOptionGroupName sets the OptionGroupName field's value.

func (*AwsRdsDbSnapshotDetails) SetPercentProgress added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbSnapshotDetails

SetPercentProgress sets the PercentProgress field's value.

func (*AwsRdsDbSnapshotDetails) SetPort added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetPort(v int64) *AwsRdsDbSnapshotDetails

SetPort sets the Port field's value.

func (*AwsRdsDbSnapshotDetails) SetProcessorFeatures added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbSnapshotDetails

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*AwsRdsDbSnapshotDetails) SetSnapshotCreateTime added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbSnapshotDetails

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*AwsRdsDbSnapshotDetails) SetSnapshotType added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetSnapshotType(v string) *AwsRdsDbSnapshotDetails

SetSnapshotType sets the SnapshotType field's value.

func (*AwsRdsDbSnapshotDetails) SetSourceDbSnapshotIdentifier added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetSourceDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails

SetSourceDbSnapshotIdentifier sets the SourceDbSnapshotIdentifier field's value.

func (*AwsRdsDbSnapshotDetails) SetSourceRegion added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetSourceRegion(v string) *AwsRdsDbSnapshotDetails

SetSourceRegion sets the SourceRegion field's value.

func (*AwsRdsDbSnapshotDetails) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (*AwsRdsDbSnapshotDetails) SetStorageType added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetStorageType(v string) *AwsRdsDbSnapshotDetails

SetStorageType sets the StorageType field's value.

func (*AwsRdsDbSnapshotDetails) SetTdeCredentialArn added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetTdeCredentialArn(v string) *AwsRdsDbSnapshotDetails

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*AwsRdsDbSnapshotDetails) SetTimezone added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetTimezone(v string) *AwsRdsDbSnapshotDetails

SetTimezone sets the Timezone field's value.

func (*AwsRdsDbSnapshotDetails) SetVpcId added in v1.34.7 

func (s *AwsRdsDbSnapshotDetails) SetVpcId(v string) *AwsRdsDbSnapshotDetails

SetVpcId sets the VpcId field's value.

func (AwsRdsDbSnapshotDetails) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbStatusInfo) SetMessage(v string) *AwsRdsDbStatusInfo

SetMessage sets the Message field's value.

func (*AwsRdsDbStatusInfo) SetNormal added in v1.34.7 

func (s *AwsRdsDbStatusInfo) SetNormal(v bool) *AwsRdsDbStatusInfo

SetNormal sets the Normal field's value.

func (*AwsRdsDbStatusInfo) SetStatus added in v1.34.7 

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

SetStatus sets the Status field's value.

func (*AwsRdsDbStatusInfo) SetStatusType added in v1.34.7 

func (s *AwsRdsDbStatusInfo) SetStatusType(v string) *AwsRdsDbStatusInfo

SetStatusType sets the StatusType field's value.

func (AwsRdsDbStatusInfo) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupArn(v string) *AwsRdsDbSubnetGroup

SetDbSubnetGroupArn sets the DbSubnetGroupArn field's value.

func (*AwsRdsDbSubnetGroup) SetDbSubnetGroupDescription added in v1.34.7 

func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupDescription(v string) *AwsRdsDbSubnetGroup

SetDbSubnetGroupDescription sets the DbSubnetGroupDescription field's value.

func (*AwsRdsDbSubnetGroup) SetDbSubnetGroupName added in v1.34.7 

func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupName(v string) *AwsRdsDbSubnetGroup

SetDbSubnetGroupName sets the DbSubnetGroupName field's value.

func (*AwsRdsDbSubnetGroup) SetSubnetGroupStatus added in v1.34.7 

func (s *AwsRdsDbSubnetGroup) SetSubnetGroupStatus(v string) *AwsRdsDbSubnetGroup

SetSubnetGroupStatus sets the SubnetGroupStatus field's value.

func (*AwsRdsDbSubnetGroup) SetSubnets added in v1.34.7 

func (s *AwsRdsDbSubnetGroup) SetSubnets(v []*AwsRdsDbSubnetGroupSubnet) *AwsRdsDbSubnetGroup

SetSubnets sets the Subnets field's value.

func (*AwsRdsDbSubnetGroup) SetVpcId added in v1.34.7 

func (s *AwsRdsDbSubnetGroup) SetVpcId(v string) *AwsRdsDbSubnetGroup

SetVpcId sets the VpcId field's value.

func (AwsRdsDbSubnetGroup) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetAvailabilityZone(v *AwsRdsDbSubnetGroupSubnetAvailabilityZone) *AwsRdsDbSubnetGroupSubnet

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*AwsRdsDbSubnetGroupSubnet) SetSubnetIdentifier added in v1.34.7 

func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetIdentifier(v string) *AwsRdsDbSubnetGroupSubnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

func (*AwsRdsDbSubnetGroupSubnet) SetSubnetStatus added in v1.34.7 

func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetStatus(v string) *AwsRdsDbSubnetGroupSubnet

SetSubnetStatus sets the SubnetStatus field's value.

func (AwsRdsDbSubnetGroupSubnet) String added in v1.34.7 

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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsRdsDbSubnetGroupSubnetAvailabilityZone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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

SetName sets the Name field's value.

func (AwsRdsDbSubnetGroupSubnetAvailabilityZone) String added in v1.34.7 

func (s AwsRdsDbSubnetGroupSubnetAvailabilityZone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.40.7 

func (s AwsRdsEventSubscriptionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetCustSubscriptionId(v string) *AwsRdsEventSubscriptionDetails

SetCustSubscriptionId sets the CustSubscriptionId field's value.

func (*AwsRdsEventSubscriptionDetails) SetCustomerAwsId added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetCustomerAwsId(v string) *AwsRdsEventSubscriptionDetails

SetCustomerAwsId sets the CustomerAwsId field's value.

func (*AwsRdsEventSubscriptionDetails) SetEnabled added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetEnabled(v bool) *AwsRdsEventSubscriptionDetails

SetEnabled sets the Enabled field's value.

func (*AwsRdsEventSubscriptionDetails) SetEventCategoriesList added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetEventCategoriesList(v []*string) *AwsRdsEventSubscriptionDetails

SetEventCategoriesList sets the EventCategoriesList field's value.

func (*AwsRdsEventSubscriptionDetails) SetEventSubscriptionArn added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetEventSubscriptionArn(v string) *AwsRdsEventSubscriptionDetails

SetEventSubscriptionArn sets the EventSubscriptionArn field's value.

func (*AwsRdsEventSubscriptionDetails) SetSnsTopicArn added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetSnsTopicArn(v string) *AwsRdsEventSubscriptionDetails

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*AwsRdsEventSubscriptionDetails) SetSourceIdsList added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetSourceIdsList(v []*string) *AwsRdsEventSubscriptionDetails

SetSourceIdsList sets the SourceIdsList field's value.

func (*AwsRdsEventSubscriptionDetails) SetSourceType added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetSourceType(v string) *AwsRdsEventSubscriptionDetails

SetSourceType sets the SourceType field's value.

func (*AwsRdsEventSubscriptionDetails) SetStatus added in v1.40.7 

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

SetStatus sets the Status field's value.

func (*AwsRdsEventSubscriptionDetails) SetSubscriptionCreationTime added in v1.40.7 

func (s *AwsRdsEventSubscriptionDetails) SetSubscriptionCreationTime(v string) *AwsRdsEventSubscriptionDetails

SetSubscriptionCreationTime sets the SubscriptionCreationTime field's value.

func (AwsRdsEventSubscriptionDetails) String added in v1.40.7 

func (s AwsRdsEventSubscriptionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsRdsPendingCloudWatchLogsExports) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsRdsPendingCloudWatchLogsExports) SetLogTypesToDisable(v []*string) *AwsRdsPendingCloudWatchLogsExports

SetLogTypesToDisable sets the LogTypesToDisable field's value.

func (*AwsRdsPendingCloudWatchLogsExports) SetLogTypesToEnable added in v1.34.7 

func (s *AwsRdsPendingCloudWatchLogsExports) SetLogTypesToEnable(v []*string) *AwsRdsPendingCloudWatchLogsExports

SetLogTypesToEnable sets the LogTypesToEnable field's value.

func (AwsRdsPendingCloudWatchLogsExports) String added in v1.34.7 

func (s AwsRdsPendingCloudWatchLogsExports) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterClusterNode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterClusterNode) SetNodeRole(v string) *AwsRedshiftClusterClusterNode

SetNodeRole sets the NodeRole field's value.

func (*AwsRedshiftClusterClusterNode) SetPrivateIpAddress added in v1.35.0 

func (s *AwsRedshiftClusterClusterNode) SetPrivateIpAddress(v string) *AwsRedshiftClusterClusterNode

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*AwsRedshiftClusterClusterNode) SetPublicIpAddress added in v1.35.0 

func (s *AwsRedshiftClusterClusterNode) SetPublicIpAddress(v string) *AwsRedshiftClusterClusterNode

SetPublicIpAddress sets the PublicIpAddress field's value.

func (AwsRedshiftClusterClusterNode) String added in v1.35.0 

func (s AwsRedshiftClusterClusterNode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterClusterParameterGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterClusterParameterGroup) SetClusterParameterStatusList(v []*AwsRedshiftClusterClusterParameterStatus) *AwsRedshiftClusterClusterParameterGroup

SetClusterParameterStatusList sets the ClusterParameterStatusList field's value.

func (*AwsRedshiftClusterClusterParameterGroup) SetParameterApplyStatus added in v1.35.0 

func (s *AwsRedshiftClusterClusterParameterGroup) SetParameterApplyStatus(v string) *AwsRedshiftClusterClusterParameterGroup

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*AwsRedshiftClusterClusterParameterGroup) SetParameterGroupName added in v1.35.0 

func (s *AwsRedshiftClusterClusterParameterGroup) SetParameterGroupName(v string) *AwsRedshiftClusterClusterParameterGroup

SetParameterGroupName sets the ParameterGroupName field's value.

func (AwsRedshiftClusterClusterParameterGroup) String added in v1.35.0 

func (s AwsRedshiftClusterClusterParameterGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterClusterParameterStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterApplyErrorDescription(v string) *AwsRedshiftClusterClusterParameterStatus

SetParameterApplyErrorDescription sets the ParameterApplyErrorDescription field's value.

func (*AwsRedshiftClusterClusterParameterStatus) SetParameterApplyStatus added in v1.35.0 

func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterApplyStatus(v string) *AwsRedshiftClusterClusterParameterStatus

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*AwsRedshiftClusterClusterParameterStatus) SetParameterName added in v1.35.0 

func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterName(v string) *AwsRedshiftClusterClusterParameterStatus

SetParameterName sets the ParameterName field's value.

func (AwsRedshiftClusterClusterParameterStatus) String added in v1.35.0 

func (s AwsRedshiftClusterClusterParameterStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterClusterSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterClusterSecurityGroup) SetClusterSecurityGroupName(v string) *AwsRedshiftClusterClusterSecurityGroup

SetClusterSecurityGroupName sets the ClusterSecurityGroupName field's value.

func (*AwsRedshiftClusterClusterSecurityGroup) SetStatus added in v1.35.0 

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

SetStatus sets the Status field's value.

func (AwsRedshiftClusterClusterSecurityGroup) String added in v1.35.0 

func (s AwsRedshiftClusterClusterSecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterClusterSnapshotCopyStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetDestinationRegion(v string) *AwsRedshiftClusterClusterSnapshotCopyStatus

SetDestinationRegion sets the DestinationRegion field's value.

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetManualSnapshotRetentionPeriod added in v1.35.0 

func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterClusterSnapshotCopyStatus

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetRetentionPeriod added in v1.35.0 

func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetRetentionPeriod(v int64) *AwsRedshiftClusterClusterSnapshotCopyStatus

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetSnapshotCopyGrantName added in v1.35.0 

func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetSnapshotCopyGrantName(v string) *AwsRedshiftClusterClusterSnapshotCopyStatus

SetSnapshotCopyGrantName sets the SnapshotCopyGrantName field's value.

func (AwsRedshiftClusterClusterSnapshotCopyStatus) String added in v1.35.0 

func (s AwsRedshiftClusterClusterSnapshotCopyStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

type AwsRedshiftClusterDeferredMaintenanceWindow struct {

	// The end of the time window for which maintenance was deferred.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

func (s AwsRedshiftClusterDeferredMaintenanceWindow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceEndTime(v string) *AwsRedshiftClusterDeferredMaintenanceWindow

SetDeferMaintenanceEndTime sets the DeferMaintenanceEndTime field's value.

func (*AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceIdentifier added in v1.35.0 

func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceIdentifier(v string) *AwsRedshiftClusterDeferredMaintenanceWindow

SetDeferMaintenanceIdentifier sets the DeferMaintenanceIdentifier field's value.

func (*AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceStartTime added in v1.35.0 

func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceStartTime(v string) *AwsRedshiftClusterDeferredMaintenanceWindow

SetDeferMaintenanceStartTime sets the DeferMaintenanceStartTime field's value.

func (AwsRedshiftClusterDeferredMaintenanceWindow) String added in v1.35.0 

func (s AwsRedshiftClusterDeferredMaintenanceWindow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetAllowVersionUpgrade(v bool) *AwsRedshiftClusterDetails

SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.

func (*AwsRedshiftClusterDetails) SetAutomatedSnapshotRetentionPeriod added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterDetails) SetAvailabilityZone added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetAvailabilityZone(v string) *AwsRedshiftClusterDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsRedshiftClusterDetails) SetClusterAvailabilityStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterAvailabilityStatus(v string) *AwsRedshiftClusterDetails

SetClusterAvailabilityStatus sets the ClusterAvailabilityStatus field's value.

func (*AwsRedshiftClusterDetails) SetClusterCreateTime added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterCreateTime(v string) *AwsRedshiftClusterDetails

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*AwsRedshiftClusterDetails) SetClusterIdentifier added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterIdentifier(v string) *AwsRedshiftClusterDetails

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*AwsRedshiftClusterDetails) SetClusterNodes added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterNodes(v []*AwsRedshiftClusterClusterNode) *AwsRedshiftClusterDetails

SetClusterNodes sets the ClusterNodes field's value.

func (*AwsRedshiftClusterDetails) SetClusterParameterGroups added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterParameterGroups(v []*AwsRedshiftClusterClusterParameterGroup) *AwsRedshiftClusterDetails

SetClusterParameterGroups sets the ClusterParameterGroups field's value.

func (*AwsRedshiftClusterDetails) SetClusterPublicKey added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterPublicKey(v string) *AwsRedshiftClusterDetails

SetClusterPublicKey sets the ClusterPublicKey field's value.

func (*AwsRedshiftClusterDetails) SetClusterRevisionNumber added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterRevisionNumber(v string) *AwsRedshiftClusterDetails

SetClusterRevisionNumber sets the ClusterRevisionNumber field's value.

func (*AwsRedshiftClusterDetails) SetClusterSecurityGroups added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterSecurityGroups(v []*AwsRedshiftClusterClusterSecurityGroup) *AwsRedshiftClusterDetails

SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.

func (*AwsRedshiftClusterDetails) SetClusterSnapshotCopyStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterSnapshotCopyStatus(v *AwsRedshiftClusterClusterSnapshotCopyStatus) *AwsRedshiftClusterDetails

SetClusterSnapshotCopyStatus sets the ClusterSnapshotCopyStatus field's value.

func (*AwsRedshiftClusterDetails) SetClusterStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterStatus(v string) *AwsRedshiftClusterDetails

SetClusterStatus sets the ClusterStatus field's value.

func (*AwsRedshiftClusterDetails) SetClusterSubnetGroupName added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterSubnetGroupName(v string) *AwsRedshiftClusterDetails

SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.

func (*AwsRedshiftClusterDetails) SetClusterVersion added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetClusterVersion(v string) *AwsRedshiftClusterDetails

SetClusterVersion sets the ClusterVersion field's value.

func (*AwsRedshiftClusterDetails) SetDBName added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetDBName(v string) *AwsRedshiftClusterDetails

SetDBName sets the DBName field's value.

func (*AwsRedshiftClusterDetails) SetDeferredMaintenanceWindows added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetDeferredMaintenanceWindows(v []*AwsRedshiftClusterDeferredMaintenanceWindow) *AwsRedshiftClusterDetails

SetDeferredMaintenanceWindows sets the DeferredMaintenanceWindows field's value.

func (*AwsRedshiftClusterDetails) SetElasticIpStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetElasticIpStatus(v *AwsRedshiftClusterElasticIpStatus) *AwsRedshiftClusterDetails

SetElasticIpStatus sets the ElasticIpStatus field's value.

func (*AwsRedshiftClusterDetails) SetElasticResizeNumberOfNodeOptions added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetElasticResizeNumberOfNodeOptions(v string) *AwsRedshiftClusterDetails

SetElasticResizeNumberOfNodeOptions sets the ElasticResizeNumberOfNodeOptions field's value.

func (*AwsRedshiftClusterDetails) SetEncrypted added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetEncrypted(v bool) *AwsRedshiftClusterDetails

SetEncrypted sets the Encrypted field's value.

func (*AwsRedshiftClusterDetails) SetEndpoint added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetEndpoint(v *AwsRedshiftClusterEndpoint) *AwsRedshiftClusterDetails

SetEndpoint sets the Endpoint field's value.

func (*AwsRedshiftClusterDetails) SetEnhancedVpcRouting added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterDetails

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

func (*AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTime added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTime(v string) *AwsRedshiftClusterDetails

SetExpectedNextSnapshotScheduleTime sets the ExpectedNextSnapshotScheduleTime field's value.

func (*AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTimeStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTimeStatus(v string) *AwsRedshiftClusterDetails

SetExpectedNextSnapshotScheduleTimeStatus sets the ExpectedNextSnapshotScheduleTimeStatus field's value.

func (*AwsRedshiftClusterDetails) SetHsmStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetHsmStatus(v *AwsRedshiftClusterHsmStatus) *AwsRedshiftClusterDetails

SetHsmStatus sets the HsmStatus field's value.

func (*AwsRedshiftClusterDetails) SetIamRoles added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetIamRoles(v []*AwsRedshiftClusterIamRole) *AwsRedshiftClusterDetails

SetIamRoles sets the IamRoles field's value.

func (*AwsRedshiftClusterDetails) SetKmsKeyId added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetKmsKeyId(v string) *AwsRedshiftClusterDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRedshiftClusterDetails) SetLoggingStatus added in v1.43.33 

func (s *AwsRedshiftClusterDetails) SetLoggingStatus(v *AwsRedshiftClusterLoggingStatus) *AwsRedshiftClusterDetails

SetLoggingStatus sets the LoggingStatus field's value.

func (*AwsRedshiftClusterDetails) SetMaintenanceTrackName added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetMaintenanceTrackName(v string) *AwsRedshiftClusterDetails

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

func (*AwsRedshiftClusterDetails) SetManualSnapshotRetentionPeriod added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterDetails) SetMasterUsername added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetMasterUsername(v string) *AwsRedshiftClusterDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRedshiftClusterDetails) SetNextMaintenanceWindowStartTime added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetNextMaintenanceWindowStartTime(v string) *AwsRedshiftClusterDetails

SetNextMaintenanceWindowStartTime sets the NextMaintenanceWindowStartTime field's value.

func (*AwsRedshiftClusterDetails) SetNodeType added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetNodeType(v string) *AwsRedshiftClusterDetails

SetNodeType sets the NodeType field's value.

func (*AwsRedshiftClusterDetails) SetNumberOfNodes added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetNumberOfNodes(v int64) *AwsRedshiftClusterDetails

SetNumberOfNodes sets the NumberOfNodes field's value.

func (*AwsRedshiftClusterDetails) SetPendingActions added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetPendingActions(v []*string) *AwsRedshiftClusterDetails

SetPendingActions sets the PendingActions field's value.

func (*AwsRedshiftClusterDetails) SetPendingModifiedValues added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetPendingModifiedValues(v *AwsRedshiftClusterPendingModifiedValues) *AwsRedshiftClusterDetails

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*AwsRedshiftClusterDetails) SetPreferredMaintenanceWindow added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRedshiftClusterDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsRedshiftClusterDetails) SetPubliclyAccessible added in v1.35.0 

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsRedshiftClusterDetails) SetResizeInfo added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetResizeInfo(v *AwsRedshiftClusterResizeInfo) *AwsRedshiftClusterDetails

SetResizeInfo sets the ResizeInfo field's value.

func (*AwsRedshiftClusterDetails) SetRestoreStatus added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetRestoreStatus(v *AwsRedshiftClusterRestoreStatus) *AwsRedshiftClusterDetails

SetRestoreStatus sets the RestoreStatus field's value.

func (*AwsRedshiftClusterDetails) SetSnapshotScheduleIdentifier added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleIdentifier(v string) *AwsRedshiftClusterDetails

SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.

func (*AwsRedshiftClusterDetails) SetSnapshotScheduleState added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleState(v string) *AwsRedshiftClusterDetails

SetSnapshotScheduleState sets the SnapshotScheduleState field's value.

func (*AwsRedshiftClusterDetails) SetVpcId added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetVpcId(v string) *AwsRedshiftClusterDetails

SetVpcId sets the VpcId field's value.

func (*AwsRedshiftClusterDetails) SetVpcSecurityGroups added in v1.35.0 

func (s *AwsRedshiftClusterDetails) SetVpcSecurityGroups(v []*AwsRedshiftClusterVpcSecurityGroup) *AwsRedshiftClusterDetails

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsRedshiftClusterDetails) String added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterElasticIpStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterElasticIpStatus) SetElasticIp(v string) *AwsRedshiftClusterElasticIpStatus

SetElasticIp sets the ElasticIp field's value.

func (*AwsRedshiftClusterElasticIpStatus) SetStatus added in v1.35.0 

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

SetStatus sets the Status field's value.

func (AwsRedshiftClusterElasticIpStatus) String added in v1.35.0 

func (s AwsRedshiftClusterElasticIpStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsRedshiftClusterEndpoint) SetAddress(v string) *AwsRedshiftClusterEndpoint

SetAddress sets the Address field's value.

func (*AwsRedshiftClusterEndpoint) SetPort added in v1.35.0 

func (s *AwsRedshiftClusterEndpoint) SetPort(v int64) *AwsRedshiftClusterEndpoint

SetPort sets the Port field's value.

func (AwsRedshiftClusterEndpoint) String added in v1.35.0 

func (s AwsRedshiftClusterEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsRedshiftClusterHsmStatus) SetHsmClientCertificateIdentifier(v string) *AwsRedshiftClusterHsmStatus

SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.

func (*AwsRedshiftClusterHsmStatus) SetHsmConfigurationIdentifier added in v1.35.0 

func (s *AwsRedshiftClusterHsmStatus) SetHsmConfigurationIdentifier(v string) *AwsRedshiftClusterHsmStatus

SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.

func (*AwsRedshiftClusterHsmStatus) SetStatus added in v1.35.0 

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

SetStatus sets the Status field's value.

func (AwsRedshiftClusterHsmStatus) String added in v1.35.0 

func (s AwsRedshiftClusterHsmStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsRedshiftClusterIamRole) SetApplyStatus(v string) *AwsRedshiftClusterIamRole

SetApplyStatus sets the ApplyStatus field's value.

func (*AwsRedshiftClusterIamRole) SetIamRoleArn added in v1.35.0 

func (s *AwsRedshiftClusterIamRole) SetIamRoleArn(v string) *AwsRedshiftClusterIamRole

SetIamRoleArn sets the IamRoleArn field's value.

func (AwsRedshiftClusterIamRole) String added in v1.35.0 

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.43.33 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	LastFailureTime *string `type:"string"`

	// The last time that logs were delivered successfully.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.43.33 

func (s AwsRedshiftClusterLoggingStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.43.33 

func (s *AwsRedshiftClusterLoggingStatus) SetBucketName(v string) *AwsRedshiftClusterLoggingStatus

SetBucketName sets the BucketName field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLastFailureMessage added in v1.43.33 

func (s *AwsRedshiftClusterLoggingStatus) SetLastFailureMessage(v string) *AwsRedshiftClusterLoggingStatus

SetLastFailureMessage sets the LastFailureMessage field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLastFailureTime added in v1.43.33 

func (s *AwsRedshiftClusterLoggingStatus) SetLastFailureTime(v string) *AwsRedshiftClusterLoggingStatus

SetLastFailureTime sets the LastFailureTime field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLastSuccessfulDeliveryTime added in v1.43.33 

func (s *AwsRedshiftClusterLoggingStatus) SetLastSuccessfulDeliveryTime(v string) *AwsRedshiftClusterLoggingStatus

SetLastSuccessfulDeliveryTime sets the LastSuccessfulDeliveryTime field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLoggingEnabled added in v1.43.33 

func (s *AwsRedshiftClusterLoggingStatus) SetLoggingEnabled(v bool) *AwsRedshiftClusterLoggingStatus

SetLoggingEnabled sets the LoggingEnabled field's value.

func (*AwsRedshiftClusterLoggingStatus) SetS3KeyPrefix added in v1.43.33 

func (s *AwsRedshiftClusterLoggingStatus) SetS3KeyPrefix(v string) *AwsRedshiftClusterLoggingStatus

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (AwsRedshiftClusterLoggingStatus) String added in v1.43.33 

func (s AwsRedshiftClusterLoggingStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterPendingModifiedValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterPendingModifiedValues

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetClusterIdentifier added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterIdentifier(v string) *AwsRedshiftClusterPendingModifiedValues

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetClusterType added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterType(v string) *AwsRedshiftClusterPendingModifiedValues

SetClusterType sets the ClusterType field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetClusterVersion added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterVersion(v string) *AwsRedshiftClusterPendingModifiedValues

SetClusterVersion sets the ClusterVersion field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetEncryptionType added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetEncryptionType(v string) *AwsRedshiftClusterPendingModifiedValues

SetEncryptionType sets the EncryptionType field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetEnhancedVpcRouting added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterPendingModifiedValues

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetMaintenanceTrackName added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetMaintenanceTrackName(v string) *AwsRedshiftClusterPendingModifiedValues

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetMasterUserPassword added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetMasterUserPassword(v string) *AwsRedshiftClusterPendingModifiedValues

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetNodeType added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetNodeType(v string) *AwsRedshiftClusterPendingModifiedValues

SetNodeType sets the NodeType field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetNumberOfNodes added in v1.35.0 

func (s *AwsRedshiftClusterPendingModifiedValues) SetNumberOfNodes(v int64) *AwsRedshiftClusterPendingModifiedValues

SetNumberOfNodes sets the NumberOfNodes field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetPubliclyAccessible added in v1.35.0 

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (AwsRedshiftClusterPendingModifiedValues) String added in v1.35.0 

func (s AwsRedshiftClusterPendingModifiedValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

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 added in v1.35.0 

func (s *AwsRedshiftClusterResizeInfo) SetAllowCancelResize(v bool) *AwsRedshiftClusterResizeInfo

SetAllowCancelResize sets the AllowCancelResize field's value.

func (*AwsRedshiftClusterResizeInfo) SetResizeType added in v1.35.0 

func (s *AwsRedshiftClusterResizeInfo) SetResizeType(v string) *AwsRedshiftClusterResizeInfo

SetResizeType sets the ResizeType field's value.

func (AwsRedshiftClusterResizeInfo) String added in v1.35.0 

func (s AwsRedshiftClusterResizeInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterRestoreStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

func (s *AwsRedshiftClusterRestoreStatus) SetCurrentRestoreRateInMegaBytesPerSecond(v float64) *AwsRedshiftClusterRestoreStatus

SetCurrentRestoreRateInMegaBytesPerSecond sets the CurrentRestoreRateInMegaBytesPerSecond field's value.

func (*AwsRedshiftClusterRestoreStatus) SetElapsedTimeInSeconds added in v1.35.0 

func (s *AwsRedshiftClusterRestoreStatus) SetElapsedTimeInSeconds(v int64) *AwsRedshiftClusterRestoreStatus

SetElapsedTimeInSeconds sets the ElapsedTimeInSeconds field's value.

func (*AwsRedshiftClusterRestoreStatus) SetEstimatedTimeToCompletionInSeconds added in v1.35.0 

func (s *AwsRedshiftClusterRestoreStatus) SetEstimatedTimeToCompletionInSeconds(v int64) *AwsRedshiftClusterRestoreStatus

SetEstimatedTimeToCompletionInSeconds sets the EstimatedTimeToCompletionInSeconds field's value.

func (*AwsRedshiftClusterRestoreStatus) SetProgressInMegaBytes added in v1.35.0 

func (s *AwsRedshiftClusterRestoreStatus) SetProgressInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus

SetProgressInMegaBytes sets the ProgressInMegaBytes field's value.

func (*AwsRedshiftClusterRestoreStatus) SetSnapshotSizeInMegaBytes added in v1.35.0 

func (s *AwsRedshiftClusterRestoreStatus) SetSnapshotSizeInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus

SetSnapshotSizeInMegaBytes sets the SnapshotSizeInMegaBytes field's value.

func (*AwsRedshiftClusterRestoreStatus) SetStatus added in v1.35.0 

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

SetStatus sets the Status field's value.

func (AwsRedshiftClusterRestoreStatus) String added in v1.35.0 

func (s AwsRedshiftClusterRestoreStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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 added in v1.35.0 

func (s AwsRedshiftClusterVpcSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.0 

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

SetStatus sets the Status field's value.

func (*AwsRedshiftClusterVpcSecurityGroup) SetVpcSecurityGroupId added in v1.35.0 

func (s *AwsRedshiftClusterVpcSecurityGroup) SetVpcSecurityGroupId(v string) *AwsRedshiftClusterVpcSecurityGroup

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (AwsRedshiftClusterVpcSecurityGroup) String added in v1.35.0 

func (s AwsRedshiftClusterVpcSecurityGroup) String() string

String returns the string representation.

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

type AwsRoute53HostedZoneConfigDetails added in v1.45.23 

type AwsRoute53HostedZoneConfigDetails struct {

	// Any comments that you include about the hosted zone.
	Comment *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains an optional comment about your Amazon Route 53 hosted zone.

func (AwsRoute53HostedZoneConfigDetails) GoString added in v1.45.23 

func (s AwsRoute53HostedZoneConfigDetails) GoString() string

GoString returns the string representation.

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

func (*AwsRoute53HostedZoneConfigDetails) SetComment added in v1.45.23 

func (s *AwsRoute53HostedZoneConfigDetails) SetComment(v string) *AwsRoute53HostedZoneConfigDetails

SetComment sets the Comment field's value.

func (AwsRoute53HostedZoneConfigDetails) String added in v1.45.23 

func (s AwsRoute53HostedZoneConfigDetails) String() string

String returns the string representation.

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

type AwsRoute53HostedZoneDetails added in v1.45.23 

type AwsRoute53HostedZoneDetails struct {

	// An object that contains information about the specified hosted zone.
	HostedZone *AwsRoute53HostedZoneObjectDetails `type:"structure"`

	// An object that contains a list of the authoritative name servers for a hosted
	// zone or for a reusable delegation set.
	NameServers []*string `type:"list"`

	// An array that contains one QueryLoggingConfig element for each DNS query
	// logging configuration that is associated with the current Amazon Web Services
	// account.
	QueryLoggingConfig *AwsRoute53QueryLoggingConfigDetails `type:"structure"`

	// An object that contains information about the Amazon Virtual Private Clouds
	// (Amazon VPCs) that are associated with the specified hosted zone.
	Vpcs []*AwsRoute53HostedZoneVpcDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides details about a specified Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.

func (AwsRoute53HostedZoneDetails) GoString added in v1.45.23 

func (s AwsRoute53HostedZoneDetails) GoString() string

GoString returns the string representation.

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

func (*AwsRoute53HostedZoneDetails) SetHostedZone added in v1.45.23 

func (s *AwsRoute53HostedZoneDetails) SetHostedZone(v *AwsRoute53HostedZoneObjectDetails) *AwsRoute53HostedZoneDetails

SetHostedZone sets the HostedZone field's value.

func (*AwsRoute53HostedZoneDetails) SetNameServers added in v1.45.23 

func (s *AwsRoute53HostedZoneDetails) SetNameServers(v []*string) *AwsRoute53HostedZoneDetails

SetNameServers sets the NameServers field's value.

func (*AwsRoute53HostedZoneDetails) SetQueryLoggingConfig added in v1.45.23 

func (s *AwsRoute53HostedZoneDetails) SetQueryLoggingConfig(v *AwsRoute53QueryLoggingConfigDetails) *AwsRoute53HostedZoneDetails

SetQueryLoggingConfig sets the QueryLoggingConfig field's value.

func (*AwsRoute53HostedZoneDetails) SetVpcs added in v1.45.23 

func (s *AwsRoute53HostedZoneDetails) SetVpcs(v []*AwsRoute53HostedZoneVpcDetails) *AwsRoute53HostedZoneDetails

SetVpcs sets the Vpcs field's value.

func (AwsRoute53HostedZoneDetails) String added in v1.45.23 

func (s AwsRoute53HostedZoneDetails) String() string

String returns the string representation.

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

type AwsRoute53HostedZoneObjectDetails added in v1.45.23 

type AwsRoute53HostedZoneObjectDetails struct {

	// An object that includes the Comment element.
	Config *AwsRoute53HostedZoneConfigDetails `type:"structure"`

	// The ID that Route 53 assigns to the hosted zone when you create it.
	Id *string `type:"string"`

	// The name of the domain. For public hosted zones, this is the name that you
	// have registered with your DNS registrar.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about an Amazon Route 53 hosted zone.

func (AwsRoute53HostedZoneObjectDetails) GoString added in v1.45.23 

func (s AwsRoute53HostedZoneObjectDetails) GoString() string

GoString returns the string representation.

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

func (*AwsRoute53HostedZoneObjectDetails) SetConfig added in v1.45.23 

func (s *AwsRoute53HostedZoneObjectDetails) SetConfig(v *AwsRoute53HostedZoneConfigDetails) *AwsRoute53HostedZoneObjectDetails

SetConfig sets the Config field's value.

func (*AwsRoute53HostedZoneObjectDetails) SetId added in v1.45.23 

func (s *AwsRoute53HostedZoneObjectDetails) SetId(v string) *AwsRoute53HostedZoneObjectDetails

SetId sets the Id field's value.

func (*AwsRoute53HostedZoneObjectDetails) SetName added in v1.45.23 

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

SetName sets the Name field's value.

func (AwsRoute53HostedZoneObjectDetails) String added in v1.45.23 

func (s AwsRoute53HostedZoneObjectDetails) String() string

String returns the string representation.

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

type AwsRoute53HostedZoneVpcDetails added in v1.45.23 

type AwsRoute53HostedZoneVpcDetails struct {

	// The identifier of an Amazon VPC.
	Id *string `type:"string"`

	// The Amazon Web Services Region that an Amazon VPC was created in.
	Region *string `type:"string"`
	// contains filtered or unexported fields
}

For private hosted zones, this is a complex type that contains information about an Amazon VPC.

func (AwsRoute53HostedZoneVpcDetails) GoString added in v1.45.23 

func (s AwsRoute53HostedZoneVpcDetails) GoString() string

GoString returns the string representation.

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

func (*AwsRoute53HostedZoneVpcDetails) SetId added in v1.45.23 

func (s *AwsRoute53HostedZoneVpcDetails) SetId(v string) *AwsRoute53HostedZoneVpcDetails

SetId sets the Id field's value.

func (*AwsRoute53HostedZoneVpcDetails) SetRegion added in v1.45.23 

func (s *AwsRoute53HostedZoneVpcDetails) SetRegion(v string) *AwsRoute53HostedZoneVpcDetails

SetRegion sets the Region field's value.

func (AwsRoute53HostedZoneVpcDetails) String added in v1.45.23 

func (s AwsRoute53HostedZoneVpcDetails) String() string

String returns the string representation.

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

type AwsRoute53QueryLoggingConfigDetails added in v1.45.23 

type AwsRoute53QueryLoggingConfigDetails struct {

	// The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that
	// Route 53 is publishing logs to.
	CloudWatchLogsLogGroupArn *CloudWatchLogsLogGroupArnConfigDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about a specified Amazon Route 53 configuration for DNS query logging.

func (AwsRoute53QueryLoggingConfigDetails) GoString added in v1.45.23 

func (s AwsRoute53QueryLoggingConfigDetails) GoString() string

GoString returns the string representation.

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

func (*AwsRoute53QueryLoggingConfigDetails) SetCloudWatchLogsLogGroupArn added in v1.45.23 

func (s *AwsRoute53QueryLoggingConfigDetails) SetCloudWatchLogsLogGroupArn(v *CloudWatchLogsLogGroupArnConfigDetails) *AwsRoute53QueryLoggingConfigDetails

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (AwsRoute53QueryLoggingConfigDetails) String added in v1.45.23 

func (s AwsRoute53QueryLoggingConfigDetails) String() string

String returns the string representation.

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

type AwsS3AccessPointDetails added in v1.49.0 

type AwsS3AccessPointDetails struct {

	// The Amazon Resource Name (ARN) of the access point.
	AccessPointArn *string `type:"string"`

	// The name or alias of the access point.
	Alias *string `type:"string"`

	// The name of the S3 bucket associated with the specified access point.
	Bucket *string `type:"string"`

	// The Amazon Web Services account ID associated with the S3 bucket associated
	// with this access point.
	BucketAccountId *string `type:"string"`

	// The name of the specified access point.
	Name *string `type:"string"`

	// Indicates whether this access point allows access from the public internet.
	NetworkOrigin *string `type:"string"`

	// provides information about the Amazon S3 Public Access Block configuration
	// for accounts.
	PublicAccessBlockConfiguration *AwsS3AccountPublicAccessBlockDetails `type:"structure"`

	// Contains the virtual private cloud (VPC) configuration for the specified
	// access point.
	VpcConfiguration *AwsS3AccessPointVpcConfigurationDetails `type:"structure"`
	// contains filtered or unexported fields
}

Returns configuration information about the specified Amazon S3 access point. S3 access points are named network endpoints that are attached to buckets that you can use to perform S3 object operations.

func (AwsS3AccessPointDetails) GoString added in v1.49.0 

func (s AwsS3AccessPointDetails) GoString() string

GoString returns the string representation.

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

func (*AwsS3AccessPointDetails) SetAccessPointArn added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetAccessPointArn(v string) *AwsS3AccessPointDetails

SetAccessPointArn sets the AccessPointArn field's value.

func (*AwsS3AccessPointDetails) SetAlias added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetAlias(v string) *AwsS3AccessPointDetails

SetAlias sets the Alias field's value.

func (*AwsS3AccessPointDetails) SetBucket added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetBucket(v string) *AwsS3AccessPointDetails

SetBucket sets the Bucket field's value.

func (*AwsS3AccessPointDetails) SetBucketAccountId added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetBucketAccountId(v string) *AwsS3AccessPointDetails

SetBucketAccountId sets the BucketAccountId field's value.

func (*AwsS3AccessPointDetails) SetName added in v1.49.0 

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

SetName sets the Name field's value.

func (*AwsS3AccessPointDetails) SetNetworkOrigin added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetNetworkOrigin(v string) *AwsS3AccessPointDetails

SetNetworkOrigin sets the NetworkOrigin field's value.

func (*AwsS3AccessPointDetails) SetPublicAccessBlockConfiguration added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetPublicAccessBlockConfiguration(v *AwsS3AccountPublicAccessBlockDetails) *AwsS3AccessPointDetails

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (*AwsS3AccessPointDetails) SetVpcConfiguration added in v1.49.0 

func (s *AwsS3AccessPointDetails) SetVpcConfiguration(v *AwsS3AccessPointVpcConfigurationDetails) *AwsS3AccessPointDetails

SetVpcConfiguration sets the VpcConfiguration field's value.

func (AwsS3AccessPointDetails) String added in v1.49.0 

func (s AwsS3AccessPointDetails) String() string

String returns the string representation.

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

type AwsS3AccessPointVpcConfigurationDetails added in v1.49.0 

type AwsS3AccessPointVpcConfigurationDetails struct {

	// If this field is specified, this access point will only allow connections
	// from the specified VPC ID.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

The virtual private cloud (VPC) configuration for an Amazon S3 access point.

func (AwsS3AccessPointVpcConfigurationDetails) GoString added in v1.49.0 

func (s AwsS3AccessPointVpcConfigurationDetails) GoString() string

GoString returns the string representation.

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

func (*AwsS3AccessPointVpcConfigurationDetails) SetVpcId added in v1.49.0 

func (s *AwsS3AccessPointVpcConfigurationDetails) SetVpcId(v string) *AwsS3AccessPointVpcConfigurationDetails

SetVpcId sets the VpcId field's value.

func (AwsS3AccessPointVpcConfigurationDetails) String added in v1.49.0 

func (s AwsS3AccessPointVpcConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.0 

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 added in v1.38.0 

func (s AwsS3AccountPublicAccessBlockDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.0 

func (s *AwsS3AccountPublicAccessBlockDetails) SetBlockPublicAcls(v bool) *AwsS3AccountPublicAccessBlockDetails

SetBlockPublicAcls sets the BlockPublicAcls field's value.

func (*AwsS3AccountPublicAccessBlockDetails) SetBlockPublicPolicy added in v1.38.0 

func (s *AwsS3AccountPublicAccessBlockDetails) SetBlockPublicPolicy(v bool) *AwsS3AccountPublicAccessBlockDetails

SetBlockPublicPolicy sets the BlockPublicPolicy field's value.

func (*AwsS3AccountPublicAccessBlockDetails) SetIgnorePublicAcls added in v1.38.0 

func (s *AwsS3AccountPublicAccessBlockDetails) SetIgnorePublicAcls(v bool) *AwsS3AccountPublicAccessBlockDetails

SetIgnorePublicAcls sets the IgnorePublicAcls field's value.

func (*AwsS3AccountPublicAccessBlockDetails) SetRestrictPublicBuckets added in v1.38.0 

func (s *AwsS3AccountPublicAccessBlockDetails) SetRestrictPublicBuckets(v bool) *AwsS3AccountPublicAccessBlockDetails

SetRestrictPublicBuckets sets the RestrictPublicBuckets field's value.

func (AwsS3AccountPublicAccessBlockDetails) String added in v1.38.0 

func (s AwsS3AccountPublicAccessBlockDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationDetails) SetRules(v []*AwsS3BucketBucketLifecycleConfigurationRulesDetails) *AwsS3BucketBucketLifecycleConfigurationDetails

SetRules sets the Rules field's value.

func (AwsS3BucketBucketLifecycleConfigurationDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) SetDaysAfterInitiation(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails

SetDaysAfterInitiation sets the DaysAfterInitiation field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetAbortIncompleteMultipartUpload(v *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetAbortIncompleteMultipartUpload sets the AbortIncompleteMultipartUpload field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationDate added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationDate(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetExpirationDate sets the ExpirationDate field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationInDays added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationInDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetExpirationInDays sets the ExpirationInDays field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpiredObjectDeleteMarker added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpiredObjectDeleteMarker(v bool) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetExpiredObjectDeleteMarker sets the ExpiredObjectDeleteMarker field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetFilter added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetFilter(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetFilter sets the Filter field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetID added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetID(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetID sets the ID field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionExpirationInDays added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionExpirationInDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetNoncurrentVersionExpirationInDays sets the NoncurrentVersionExpirationInDays field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionTransitions added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionTransitions(v []*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetNoncurrentVersionTransitions sets the NoncurrentVersionTransitions field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetPrefix added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetPrefix(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetPrefix sets the Prefix field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetStatus added in v1.38.67 

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

SetStatus sets the Status field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetTransitions added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetTransitions(v []*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails

SetTransitions sets the Transitions field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) SetPredicate(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails

SetPredicate sets the Predicate field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetOperands(v []*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails

SetOperands sets the Operands field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetPrefix added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetPrefix(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails

SetPrefix sets the Prefix field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetTag added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetTag(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails

SetTag sets the Tag field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetType added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetType(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails

SetType sets the Type field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetPrefix(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails

SetPrefix sets the Prefix field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetTag added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetTag(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails

SetTag sets the Tag field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetType added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetType(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails

SetType sets the Type field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetKey(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails

SetKey sets the Key field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetValue added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetValue(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails

SetValue sets the Value field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetKey(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails

SetKey sets the Key field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetValue added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetValue(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails

SetValue sets the Value field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails

SetDays sets the Days field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetStorageClass added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetStorageClass(v string) *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails

SetStorageClass sets the StorageClass field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails struct {

	// A date on which to transition objects to the specified storage class. If
	// you provide Date, you cannot provide Days.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDate(v string) *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails

SetDate sets the Date field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDays added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails

SetDays sets the Days field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetStorageClass added in v1.38.67 

func (s *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetStorageClass(v string) *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails

SetStorageClass sets the StorageClass field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) String added in v1.38.67 

func (s AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s AwsS3BucketBucketVersioningConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *AwsS3BucketBucketVersioningConfiguration) SetIsMfaDeleteEnabled(v bool) *AwsS3BucketBucketVersioningConfiguration

SetIsMfaDeleteEnabled sets the IsMfaDeleteEnabled field's value.

func (*AwsS3BucketBucketVersioningConfiguration) SetStatus added in v1.42.24 

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

SetStatus sets the Status field's value.

func (AwsS3BucketBucketVersioningConfiguration) String added in v1.42.24 

func (s AwsS3BucketBucketVersioningConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 specified 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	CreatedAt *string `type:"string"`

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

	// Specifies which rule Amazon S3 applies by default to every new object placed
	// in the 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 Simple Storage Service (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 added in v1.40.36 

func (s *AwsS3BucketDetails) SetAccessControlList(v string) *AwsS3BucketDetails

SetAccessControlList sets the AccessControlList field's value.

func (*AwsS3BucketDetails) SetBucketLifecycleConfiguration added in v1.38.67 

func (s *AwsS3BucketDetails) SetBucketLifecycleConfiguration(v *AwsS3BucketBucketLifecycleConfigurationDetails) *AwsS3BucketDetails

SetBucketLifecycleConfiguration sets the BucketLifecycleConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketLoggingConfiguration added in v1.40.36 

func (s *AwsS3BucketDetails) SetBucketLoggingConfiguration(v *AwsS3BucketLoggingConfiguration) *AwsS3BucketDetails

SetBucketLoggingConfiguration sets the BucketLoggingConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketNotificationConfiguration added in v1.40.36 

func (s *AwsS3BucketDetails) SetBucketNotificationConfiguration(v *AwsS3BucketNotificationConfiguration) *AwsS3BucketDetails

SetBucketNotificationConfiguration sets the BucketNotificationConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketVersioningConfiguration added in v1.42.24 

func (s *AwsS3BucketDetails) SetBucketVersioningConfiguration(v *AwsS3BucketBucketVersioningConfiguration) *AwsS3BucketDetails

SetBucketVersioningConfiguration sets the BucketVersioningConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketWebsiteConfiguration added in v1.40.36 

func (s *AwsS3BucketDetails) SetBucketWebsiteConfiguration(v *AwsS3BucketWebsiteConfiguration) *AwsS3BucketDetails

SetBucketWebsiteConfiguration sets the BucketWebsiteConfiguration field's value.

func (*AwsS3BucketDetails) SetCreatedAt added in v1.29.23 

func (s *AwsS3BucketDetails) SetCreatedAt(v string) *AwsS3BucketDetails

SetCreatedAt sets the CreatedAt field's value.

func (*AwsS3BucketDetails) SetName added in v1.49.0 

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

SetName sets the Name field's value.

func (*AwsS3BucketDetails) SetObjectLockConfiguration added in v1.44.230 

func (s *AwsS3BucketDetails) SetObjectLockConfiguration(v *AwsS3BucketObjectLockConfiguration) *AwsS3BucketDetails

SetObjectLockConfiguration sets the ObjectLockConfiguration field's value.

func (*AwsS3BucketDetails) SetOwnerAccountId added in v1.40.59 

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 added in v1.38.0 

func (s *AwsS3BucketDetails) SetPublicAccessBlockConfiguration(v *AwsS3AccountPublicAccessBlockDetails) *AwsS3BucketDetails

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (*AwsS3BucketDetails) SetServerSideEncryptionConfiguration added in v1.29.23 

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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketLoggingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketLoggingConfiguration) SetDestinationBucketName(v string) *AwsS3BucketLoggingConfiguration

SetDestinationBucketName sets the DestinationBucketName field's value.

func (*AwsS3BucketLoggingConfiguration) SetLogFilePrefix added in v1.40.36 

func (s *AwsS3BucketLoggingConfiguration) SetLogFilePrefix(v string) *AwsS3BucketLoggingConfiguration

SetLogFilePrefix sets the LogFilePrefix field's value.

func (AwsS3BucketLoggingConfiguration) String added in v1.40.36 

func (s AwsS3BucketLoggingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketNotificationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketNotificationConfiguration) SetConfigurations(v []*AwsS3BucketNotificationConfigurationDetail) *AwsS3BucketNotificationConfiguration

SetConfigurations sets the Configurations field's value.

func (AwsS3BucketNotificationConfiguration) String added in v1.40.36 

func (s AwsS3BucketNotificationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationDetail) SetDestination(v string) *AwsS3BucketNotificationConfigurationDetail

SetDestination sets the Destination field's value.

func (*AwsS3BucketNotificationConfigurationDetail) SetEvents added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationDetail) SetEvents(v []*string) *AwsS3BucketNotificationConfigurationDetail

SetEvents sets the Events field's value.

func (*AwsS3BucketNotificationConfigurationDetail) SetFilter added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationDetail) SetFilter(v *AwsS3BucketNotificationConfigurationFilter) *AwsS3BucketNotificationConfigurationDetail

SetFilter sets the Filter field's value.

func (*AwsS3BucketNotificationConfigurationDetail) SetType added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationDetail) SetType(v string) *AwsS3BucketNotificationConfigurationDetail

SetType sets the Type field's value.

func (AwsS3BucketNotificationConfigurationDetail) String added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationFilter) SetS3KeyFilter(v *AwsS3BucketNotificationConfigurationS3KeyFilter) *AwsS3BucketNotificationConfigurationFilter

SetS3KeyFilter sets the S3KeyFilter field's value.

func (AwsS3BucketNotificationConfigurationFilter) String added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationS3KeyFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationS3KeyFilter) SetFilterRules(v []*AwsS3BucketNotificationConfigurationS3KeyFilterRule) *AwsS3BucketNotificationConfigurationS3KeyFilter

SetFilterRules sets the FilterRules field's value.

func (AwsS3BucketNotificationConfigurationS3KeyFilter) String added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationS3KeyFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationS3KeyFilterRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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

SetName sets the Name field's value.

func (*AwsS3BucketNotificationConfigurationS3KeyFilterRule) SetValue added in v1.40.36 

func (s *AwsS3BucketNotificationConfigurationS3KeyFilterRule) SetValue(v string) *AwsS3BucketNotificationConfigurationS3KeyFilterRule

SetValue sets the Value field's value.

func (AwsS3BucketNotificationConfigurationS3KeyFilterRule) String added in v1.40.36 

func (s AwsS3BucketNotificationConfigurationS3KeyFilterRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

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.44.230 

func (s AwsS3BucketObjectLockConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

func (s *AwsS3BucketObjectLockConfiguration) SetObjectLockEnabled(v string) *AwsS3BucketObjectLockConfiguration

SetObjectLockEnabled sets the ObjectLockEnabled field's value.

func (*AwsS3BucketObjectLockConfiguration) SetRule added in v1.44.230 

func (s *AwsS3BucketObjectLockConfiguration) SetRule(v *AwsS3BucketObjectLockConfigurationRuleDetails) *AwsS3BucketObjectLockConfiguration

SetRule sets the Rule field's value.

func (AwsS3BucketObjectLockConfiguration) String added in v1.44.230 

func (s AwsS3BucketObjectLockConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

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.44.230 

func (s AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

func (s *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetDays(v int64) *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails

SetDays sets the Days field's value.

func (*AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetMode added in v1.44.230 

func (s *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetMode(v string) *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails

SetMode sets the Mode field's value.

func (*AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetYears added in v1.44.230 

func (s *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetYears(v int64) *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails

SetYears sets the Years field's value.

func (AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) String added in v1.44.230 

func (s AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

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.44.230 

func (s AwsS3BucketObjectLockConfigurationRuleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.230 

func (s *AwsS3BucketObjectLockConfigurationRuleDetails) SetDefaultRetention(v *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) *AwsS3BucketObjectLockConfigurationRuleDetails

SetDefaultRetention sets the DefaultRetention field's value.

func (AwsS3BucketObjectLockConfigurationRuleDetails) String added in v1.44.230 

func (s AwsS3BucketObjectLockConfigurationRuleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

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 added in v1.29.23 

func (s AwsS3BucketServerSideEncryptionByDefault) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

func (s *AwsS3BucketServerSideEncryptionByDefault) SetKMSMasterKeyID(v string) *AwsS3BucketServerSideEncryptionByDefault

SetKMSMasterKeyID sets the KMSMasterKeyID field's value.

func (*AwsS3BucketServerSideEncryptionByDefault) SetSSEAlgorithm added in v1.29.23 

func (s *AwsS3BucketServerSideEncryptionByDefault) SetSSEAlgorithm(v string) *AwsS3BucketServerSideEncryptionByDefault

SetSSEAlgorithm sets the SSEAlgorithm field's value.

func (AwsS3BucketServerSideEncryptionByDefault) String added in v1.29.23 

func (s AwsS3BucketServerSideEncryptionByDefault) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

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 added in v1.29.23 

func (s AwsS3BucketServerSideEncryptionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

func (s *AwsS3BucketServerSideEncryptionConfiguration) SetRules(v []*AwsS3BucketServerSideEncryptionRule) *AwsS3BucketServerSideEncryptionConfiguration

SetRules sets the Rules field's value.

func (AwsS3BucketServerSideEncryptionConfiguration) String added in v1.29.23 

func (s AwsS3BucketServerSideEncryptionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

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 added in v1.29.23 

func (s AwsS3BucketServerSideEncryptionRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

func (s *AwsS3BucketServerSideEncryptionRule) SetApplyServerSideEncryptionByDefault(v *AwsS3BucketServerSideEncryptionByDefault) *AwsS3BucketServerSideEncryptionRule

SetApplyServerSideEncryptionByDefault sets the ApplyServerSideEncryptionByDefault field's value.

func (AwsS3BucketServerSideEncryptionRule) String added in v1.29.23 

func (s AwsS3BucketServerSideEncryptionRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketWebsiteConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketWebsiteConfiguration) SetErrorDocument(v string) *AwsS3BucketWebsiteConfiguration

SetErrorDocument sets the ErrorDocument field's value.

func (*AwsS3BucketWebsiteConfiguration) SetIndexDocumentSuffix added in v1.40.36 

func (s *AwsS3BucketWebsiteConfiguration) SetIndexDocumentSuffix(v string) *AwsS3BucketWebsiteConfiguration

SetIndexDocumentSuffix sets the IndexDocumentSuffix field's value.

func (*AwsS3BucketWebsiteConfiguration) SetRedirectAllRequestsTo added in v1.40.36 

func (s *AwsS3BucketWebsiteConfiguration) SetRedirectAllRequestsTo(v *AwsS3BucketWebsiteConfigurationRedirectTo) *AwsS3BucketWebsiteConfiguration

SetRedirectAllRequestsTo sets the RedirectAllRequestsTo field's value.

func (*AwsS3BucketWebsiteConfiguration) SetRoutingRules added in v1.40.36 

func (s *AwsS3BucketWebsiteConfiguration) SetRoutingRules(v []*AwsS3BucketWebsiteConfigurationRoutingRule) *AwsS3BucketWebsiteConfiguration

SetRoutingRules sets the RoutingRules field's value.

func (AwsS3BucketWebsiteConfiguration) String added in v1.40.36 

func (s AwsS3BucketWebsiteConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRedirectTo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRedirectTo) SetHostname(v string) *AwsS3BucketWebsiteConfigurationRedirectTo

SetHostname sets the Hostname field's value.

func (*AwsS3BucketWebsiteConfigurationRedirectTo) SetProtocol added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRedirectTo) SetProtocol(v string) *AwsS3BucketWebsiteConfigurationRedirectTo

SetProtocol sets the Protocol field's value.

func (AwsS3BucketWebsiteConfigurationRedirectTo) String added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRedirectTo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRoutingRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRule) SetCondition(v *AwsS3BucketWebsiteConfigurationRoutingRuleCondition) *AwsS3BucketWebsiteConfigurationRoutingRule

SetCondition sets the Condition field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRule) SetRedirect added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRule) SetRedirect(v *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) *AwsS3BucketWebsiteConfigurationRoutingRule

SetRedirect sets the Redirect field's value.

func (AwsS3BucketWebsiteConfigurationRoutingRule) String added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRoutingRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRoutingRuleCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleCondition) SetHttpErrorCodeReturnedEquals(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleCondition

SetHttpErrorCodeReturnedEquals sets the HttpErrorCodeReturnedEquals field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleCondition) SetKeyPrefixEquals added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleCondition) SetKeyPrefixEquals(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleCondition

SetKeyPrefixEquals sets the KeyPrefixEquals field's value.

func (AwsS3BucketWebsiteConfigurationRoutingRuleCondition) String added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRoutingRuleCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

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 added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetHostname(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect

SetHostname sets the Hostname field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetHttpRedirectCode added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetHttpRedirectCode(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect

SetHttpRedirectCode sets the HttpRedirectCode field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetProtocol added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetProtocol(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect

SetProtocol sets the Protocol field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetReplaceKeyPrefixWith added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetReplaceKeyPrefixWith(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect

SetReplaceKeyPrefixWith sets the ReplaceKeyPrefixWith field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetReplaceKeyWith added in v1.40.36 

func (s *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetReplaceKeyWith(v string) *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect

SetReplaceKeyWith sets the ReplaceKeyWith field's value.

func (AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) String added in v1.40.36 

func (s AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.23 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.29.23 

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 added in v1.29.23 

func (s *AwsS3ObjectDetails) SetContentType(v string) *AwsS3ObjectDetails

SetContentType sets the ContentType field's value.

func (*AwsS3ObjectDetails) SetETag added in v1.29.23 

func (s *AwsS3ObjectDetails) SetETag(v string) *AwsS3ObjectDetails

SetETag sets the ETag field's value.

func (*AwsS3ObjectDetails) SetLastModified added in v1.29.23 

func (s *AwsS3ObjectDetails) SetLastModified(v string) *AwsS3ObjectDetails

SetLastModified sets the LastModified field's value.

func (*AwsS3ObjectDetails) SetSSEKMSKeyId added in v1.29.23 

func (s *AwsS3ObjectDetails) SetSSEKMSKeyId(v string) *AwsS3ObjectDetails

SetSSEKMSKeyId sets the SSEKMSKeyId field's value.

func (*AwsS3ObjectDetails) SetServerSideEncryption added in v1.29.23 

func (s *AwsS3ObjectDetails) SetServerSideEncryption(v string) *AwsS3ObjectDetails

SetServerSideEncryption sets the ServerSideEncryption field's value.

func (*AwsS3ObjectDetails) SetVersionId added in v1.29.23 

func (s *AwsS3ObjectDetails) SetVersionId(v string) *AwsS3ObjectDetails

SetVersionId sets the VersionId field's value.

func (AwsS3ObjectDetails) String added in v1.29.23 

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.44.161 

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.44.161 

func (s AwsSageMakerNotebookInstanceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetAcceleratorTypes(v []*string) *AwsSageMakerNotebookInstanceDetails

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetAdditionalCodeRepositories added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetAdditionalCodeRepositories(v []*string) *AwsSageMakerNotebookInstanceDetails

SetAdditionalCodeRepositories sets the AdditionalCodeRepositories field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetDefaultCodeRepository added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetDefaultCodeRepository(v string) *AwsSageMakerNotebookInstanceDetails

SetDefaultCodeRepository sets the DefaultCodeRepository field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetDirectInternetAccess added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetDirectInternetAccess(v string) *AwsSageMakerNotebookInstanceDetails

SetDirectInternetAccess sets the DirectInternetAccess field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetFailureReason added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetFailureReason(v string) *AwsSageMakerNotebookInstanceDetails

SetFailureReason sets the FailureReason field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetInstanceMetadataServiceConfiguration added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetInstanceMetadataServiceConfiguration(v *AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) *AwsSageMakerNotebookInstanceDetails

SetInstanceMetadataServiceConfiguration sets the InstanceMetadataServiceConfiguration field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetInstanceType added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetInstanceType(v string) *AwsSageMakerNotebookInstanceDetails

SetInstanceType sets the InstanceType field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetKmsKeyId added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetKmsKeyId(v string) *AwsSageMakerNotebookInstanceDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNetworkInterfaceId added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetNetworkInterfaceId(v string) *AwsSageMakerNotebookInstanceDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceArn added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceArn(v string) *AwsSageMakerNotebookInstanceDetails

SetNotebookInstanceArn sets the NotebookInstanceArn field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceLifecycleConfigName added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceLifecycleConfigName(v string) *AwsSageMakerNotebookInstanceDetails

SetNotebookInstanceLifecycleConfigName sets the NotebookInstanceLifecycleConfigName field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceName added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceName(v string) *AwsSageMakerNotebookInstanceDetails

SetNotebookInstanceName sets the NotebookInstanceName field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceStatus added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceStatus(v string) *AwsSageMakerNotebookInstanceDetails

SetNotebookInstanceStatus sets the NotebookInstanceStatus field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetPlatformIdentifier added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetPlatformIdentifier(v string) *AwsSageMakerNotebookInstanceDetails

SetPlatformIdentifier sets the PlatformIdentifier field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetRoleArn added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetRoleArn(v string) *AwsSageMakerNotebookInstanceDetails

SetRoleArn sets the RoleArn field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetRootAccess added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetRootAccess(v string) *AwsSageMakerNotebookInstanceDetails

SetRootAccess sets the RootAccess field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetSecurityGroups added in v1.44.161 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetSubnetId added in v1.44.161 

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

SetSubnetId sets the SubnetId field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetUrl added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetUrl(v string) *AwsSageMakerNotebookInstanceDetails

SetUrl sets the Url field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetVolumeSizeInGB added in v1.44.161 

func (s *AwsSageMakerNotebookInstanceDetails) SetVolumeSizeInGB(v int64) *AwsSageMakerNotebookInstanceDetails

SetVolumeSizeInGB sets the VolumeSizeInGB field's value.

func (AwsSageMakerNotebookInstanceDetails) String added in v1.44.161 

func (s AwsSageMakerNotebookInstanceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) SetMinimumInstanceMetadataServiceVersion(v string) *AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails

SetMinimumInstanceMetadataServiceVersion sets the MinimumInstanceMetadataServiceVersion field's value.

func (AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) String added in v1.44.161 

func (s AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsSecretsManagerSecretDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsSecretsManagerSecretDetails) SetDeleted(v bool) *AwsSecretsManagerSecretDetails

SetDeleted sets the Deleted field's value.

func (*AwsSecretsManagerSecretDetails) SetDescription added in v1.34.7 

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

SetDescription sets the Description field's value.

func (*AwsSecretsManagerSecretDetails) SetKmsKeyId added in v1.34.7 

func (s *AwsSecretsManagerSecretDetails) SetKmsKeyId(v string) *AwsSecretsManagerSecretDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsSecretsManagerSecretDetails) SetName added in v1.34.7 

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

SetName sets the Name field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationEnabled added in v1.34.7 

func (s *AwsSecretsManagerSecretDetails) SetRotationEnabled(v bool) *AwsSecretsManagerSecretDetails

SetRotationEnabled sets the RotationEnabled field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationLambdaArn added in v1.34.7 

func (s *AwsSecretsManagerSecretDetails) SetRotationLambdaArn(v string) *AwsSecretsManagerSecretDetails

SetRotationLambdaArn sets the RotationLambdaArn field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationOccurredWithinFrequency added in v1.34.7 

func (s *AwsSecretsManagerSecretDetails) SetRotationOccurredWithinFrequency(v bool) *AwsSecretsManagerSecretDetails

SetRotationOccurredWithinFrequency sets the RotationOccurredWithinFrequency field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationRules added in v1.34.7 

func (s *AwsSecretsManagerSecretDetails) SetRotationRules(v *AwsSecretsManagerSecretRotationRules) *AwsSecretsManagerSecretDetails

SetRotationRules sets the RotationRules field's value.

func (AwsSecretsManagerSecretDetails) String added in v1.34.7 

func (s AwsSecretsManagerSecretDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

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 added in v1.34.7 

func (s AwsSecretsManagerSecretRotationRules) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.7 

func (s *AwsSecretsManagerSecretRotationRules) SetAutomaticallyAfterDays(v int64) *AwsSecretsManagerSecretRotationRules

SetAutomaticallyAfterDays sets the AutomaticallyAfterDays field's value.

func (AwsSecretsManagerSecretRotationRules) String added in v1.34.7 

func (s AwsSecretsManagerSecretRotationRules) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 Amazon Web Services account from which a finding was generated.
	AwsAccountName *string `type:"string"`

	// 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	FirstObservedAt *string `type:"string"`

	// Provides metadata for the Amazon CodeGuru detector associated with a finding.
	// This field pertains to findings that relate to Lambda functions. Amazon Inspector
	// identifies policy violations and vulnerabilities in Lambda function code
	// based on internal detectors developed in collaboration with Amazon CodeGuru.
	// Security Hub receives those findings.
	GeneratorDetails *GeneratorDetails `type:"structure"`

	// 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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"`

	// A imestamp that indicates when Security Hub received a finding and begins
	// to process it.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	ProcessedAt *string `type:"string"`

	// 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// 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 added in v1.36.30 

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) SetAwsAccountName added in v1.48.5 

func (s *AwsSecurityFinding) SetAwsAccountName(v string) *AwsSecurityFinding

SetAwsAccountName sets the AwsAccountName field's value.

func (*AwsSecurityFinding) SetCompanyName added in v1.40.7 

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 added in v1.38.0 

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) SetGeneratorDetails added in v1.44.327 

func (s *AwsSecurityFinding) SetGeneratorDetails(v *GeneratorDetails) *AwsSecurityFinding

SetGeneratorDetails sets the GeneratorDetails field's value.

func (*AwsSecurityFinding) SetGeneratorId 

func (s *AwsSecurityFinding) SetGeneratorId(v string) *AwsSecurityFinding

SetGeneratorId sets the GeneratorId field's value.

func (*AwsSecurityFinding) SetId 

func (s *AwsSecurityFinding) SetId(v string) *AwsSecurityFinding

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 added in v1.33.0 

func (s *AwsSecurityFinding) SetNetworkPath(v []*NetworkPathComponent) *AwsSecurityFinding

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 added in v1.34.15 

func (s *AwsSecurityFinding) SetPatchSummary(v *PatchSummary) *AwsSecurityFinding

SetPatchSummary sets the PatchSummary field's value.

func (*AwsSecurityFinding) SetProcess 

func (s *AwsSecurityFinding) SetProcess(v *ProcessDetails) *AwsSecurityFinding

SetProcess sets the Process field's value.

func (*AwsSecurityFinding) SetProcessedAt added in v1.48.5 

func (s *AwsSecurityFinding) SetProcessedAt(v string) *AwsSecurityFinding

SetProcessedAt sets the ProcessedAt 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 added in v1.40.7 

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 added in v1.40.7 

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.42 

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.44.36 

func (s *AwsSecurityFinding) SetThreats(v []*Threat) *AwsSecurityFinding

SetThreats sets the Threats field's value.

func (*AwsSecurityFinding) SetTitle 

func (s *AwsSecurityFinding) SetTitle(v string) *AwsSecurityFinding

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 added in v1.33.0 

func (s *AwsSecurityFinding) SetVulnerabilities(v []*Vulnerability) *AwsSecurityFinding

SetVulnerabilities sets the Vulnerabilities field's value.

func (*AwsSecurityFinding) SetWorkflow added in v1.29.23 

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 in which a finding is generated.
	AwsAccountId []*StringFilter `type:"list"`

	// The name of the Amazon Web Services account in which a finding is generated.
	AwsAccountName []*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"`

	// The name of a security control parameter.
	ComplianceSecurityControlParametersName []*StringFilter `type:"list"`

	// The current value of a security control parameter.
	ComplianceSecurityControlParametersValue []*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"`

	// A timestamp that indicates when the security findings provider created the
	// potential security issue that a finding reflects.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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"`

	// A timestamp that indicates when the security findings provider first observed
	// the potential security issue that a finding captured.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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"`

	// A timestamp that indicates when the security findings provider most recently
	// observed the potential security issue that a finding captured.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 ARN of the application that is related to a finding.
	ResourceApplicationArn []*StringFilter `type:"list"`

	// The name of the application that is related to a finding.
	ResourceApplicationName []*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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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"`

	// A timestamp that indicates when the security findings provider last updated
	// the finding record.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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"`

	// Indicates whether a software vulnerability in your environment has a known
	// exploit. You can filter findings by this field only if you use Security Hub
	// and Amazon Inspector.
	VulnerabilitiesExploitAvailable []*StringFilter `type:"list"`

	// Indicates whether a vulnerability is fixed in a newer version of the affected
	// software packages. You can filter findings by this field only if you use
	// Security Hub and Amazon Inspector.
	VulnerabilitiesFixAvailable []*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 filters that are applied to all active findings aggregated by Security Hub.

You can filter by up to ten 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 

func (s *AwsSecurityFindingFilters) SetAwsAccountId(v []*StringFilter) *AwsSecurityFindingFilters

SetAwsAccountId sets the AwsAccountId field's value.

func (*AwsSecurityFindingFilters) SetAwsAccountName added in v1.48.5 

func (s *AwsSecurityFindingFilters) SetAwsAccountName(v []*StringFilter) *AwsSecurityFindingFilters

SetAwsAccountName sets the AwsAccountName field's value.

func (*AwsSecurityFindingFilters) SetCompanyName 

func (s *AwsSecurityFindingFilters) SetCompanyName(v []*StringFilter) *AwsSecurityFindingFilters

SetCompanyName sets the CompanyName field's value.

func (*AwsSecurityFindingFilters) SetComplianceAssociatedStandardsId added in v1.44.191 

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

SetComplianceAssociatedStandardsId sets the ComplianceAssociatedStandardsId field's value.

func (*AwsSecurityFindingFilters) SetComplianceSecurityControlId added in v1.44.191 

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

SetComplianceSecurityControlId sets the ComplianceSecurityControlId field's value.

func (*AwsSecurityFindingFilters) SetComplianceSecurityControlParametersName added in v1.48.4 

func (s *AwsSecurityFindingFilters) SetComplianceSecurityControlParametersName(v []*StringFilter) *AwsSecurityFindingFilters

SetComplianceSecurityControlParametersName sets the ComplianceSecurityControlParametersName field's value.

func (*AwsSecurityFindingFilters) SetComplianceSecurityControlParametersValue added in v1.48.4 

func (s *AwsSecurityFindingFilters) SetComplianceSecurityControlParametersValue(v []*StringFilter) *AwsSecurityFindingFilters

SetComplianceSecurityControlParametersValue sets the ComplianceSecurityControlParametersValue field's value.

func (*AwsSecurityFindingFilters) SetComplianceStatus 

func (s *AwsSecurityFindingFilters) SetComplianceStatus(v []*StringFilter) *AwsSecurityFindingFilters

SetComplianceStatus sets the ComplianceStatus field's value.

func (*AwsSecurityFindingFilters) SetConfidence 

func (s *AwsSecurityFindingFilters) SetConfidence(v []*NumberFilter) *AwsSecurityFindingFilters

SetConfidence sets the Confidence field's value.

func (*AwsSecurityFindingFilters) SetCreatedAt 

func (s *AwsSecurityFindingFilters) SetCreatedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetCreatedAt sets the CreatedAt field's value.

func (*AwsSecurityFindingFilters) SetCriticality 

func (s *AwsSecurityFindingFilters) SetCriticality(v []*NumberFilter) *AwsSecurityFindingFilters

SetCriticality sets the Criticality field's value.

func (*AwsSecurityFindingFilters) SetDescription 

func (s *AwsSecurityFindingFilters) SetDescription(v []*StringFilter) *AwsSecurityFindingFilters

SetDescription sets the Description field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsConfidence added in v1.38.0 

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsConfidence(v []*NumberFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsConfidence sets the FindingProviderFieldsConfidence field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsCriticality added in v1.38.0 

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsCriticality(v []*NumberFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsCriticality sets the FindingProviderFieldsCriticality field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsId added in v1.38.0 

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsId(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsRelatedFindingsId sets the FindingProviderFieldsRelatedFindingsId field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsProductArn added in v1.38.0 

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsProductArn(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsRelatedFindingsProductArn sets the FindingProviderFieldsRelatedFindingsProductArn field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityLabel added in v1.38.0 

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityLabel(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsSeverityLabel sets the FindingProviderFieldsSeverityLabel field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityOriginal added in v1.38.0 

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityOriginal(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsSeverityOriginal sets the FindingProviderFieldsSeverityOriginal field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsTypes added in v1.38.0 

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 

func (s *AwsSecurityFindingFilters) SetGeneratorId(v []*StringFilter) *AwsSecurityFindingFilters

SetGeneratorId sets the GeneratorId field's value.

func (*AwsSecurityFindingFilters) SetId 

func (s *AwsSecurityFindingFilters) SetId(v []*StringFilter) *AwsSecurityFindingFilters

SetId sets the Id field's value.

func (*AwsSecurityFindingFilters) SetKeyword 

func (s *AwsSecurityFindingFilters) SetKeyword(v []*KeywordFilter) *AwsSecurityFindingFilters

SetKeyword sets the Keyword field's value.

func (*AwsSecurityFindingFilters) SetLastObservedAt 

func (s *AwsSecurityFindingFilters) SetLastObservedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetLastObservedAt sets the LastObservedAt field's value.

func (*AwsSecurityFindingFilters) SetMalwareName 

func (s *AwsSecurityFindingFilters) SetMalwareName(v []*StringFilter) *AwsSecurityFindingFilters

SetMalwareName sets the MalwareName field's value.

func (*AwsSecurityFindingFilters) SetMalwarePath 

func (s *AwsSecurityFindingFilters) SetMalwarePath(v []*StringFilter) *AwsSecurityFindingFilters

SetMalwarePath sets the MalwarePath field's value.

func (*AwsSecurityFindingFilters) SetMalwareState 

func (s *AwsSecurityFindingFilters) SetMalwareState(v []*StringFilter) *AwsSecurityFindingFilters

SetMalwareState sets the MalwareState field's value.

func (*AwsSecurityFindingFilters) SetMalwareType 

func (s *AwsSecurityFindingFilters) SetMalwareType(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetNetworkDirection(v []*StringFilter) *AwsSecurityFindingFilters

SetNetworkDirection sets the NetworkDirection field's value.

func (*AwsSecurityFindingFilters) SetNetworkProtocol 

func (s *AwsSecurityFindingFilters) SetNetworkProtocol(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetNetworkSourceMac(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetNoteText(v []*StringFilter) *AwsSecurityFindingFilters

SetNoteText sets the NoteText field's value.

func (*AwsSecurityFindingFilters) SetNoteUpdatedAt 

func (s *AwsSecurityFindingFilters) SetNoteUpdatedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetNoteUpdatedAt sets the NoteUpdatedAt field's value.

func (*AwsSecurityFindingFilters) SetNoteUpdatedBy 

func (s *AwsSecurityFindingFilters) SetNoteUpdatedBy(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetProcessName(v []*StringFilter) *AwsSecurityFindingFilters

SetProcessName sets the ProcessName field's value.

func (*AwsSecurityFindingFilters) SetProcessParentPid 

func (s *AwsSecurityFindingFilters) SetProcessParentPid(v []*NumberFilter) *AwsSecurityFindingFilters

SetProcessParentPid sets the ProcessParentPid field's value.

func (*AwsSecurityFindingFilters) SetProcessPath 

func (s *AwsSecurityFindingFilters) SetProcessPath(v []*StringFilter) *AwsSecurityFindingFilters

SetProcessPath sets the ProcessPath field's value.

func (*AwsSecurityFindingFilters) SetProcessPid 

func (s *AwsSecurityFindingFilters) SetProcessPid(v []*NumberFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetProductArn(v []*StringFilter) *AwsSecurityFindingFilters

SetProductArn sets the ProductArn field's value.

func (*AwsSecurityFindingFilters) SetProductFields 

func (s *AwsSecurityFindingFilters) SetProductFields(v []*MapFilter) *AwsSecurityFindingFilters

SetProductFields sets the ProductFields field's value.

func (*AwsSecurityFindingFilters) SetProductName 

func (s *AwsSecurityFindingFilters) SetProductName(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetRecordState(v []*StringFilter) *AwsSecurityFindingFilters

SetRecordState sets the RecordState field's value.

func (*AwsSecurityFindingFilters) SetRegion added in v1.40.7 

func (s *AwsSecurityFindingFilters) SetRegion(v []*StringFilter) *AwsSecurityFindingFilters

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) SetResourceApplicationArn added in v1.48.5 

func (s *AwsSecurityFindingFilters) SetResourceApplicationArn(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceApplicationArn sets the ResourceApplicationArn field's value.

func (*AwsSecurityFindingFilters) SetResourceApplicationName added in v1.48.5 

func (s *AwsSecurityFindingFilters) SetResourceApplicationName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceApplicationName sets the ResourceApplicationName 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 added in v1.40.7 

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 added in v1.40.7 

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 

func (s *AwsSecurityFindingFilters) SetResourceId(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetResourceRegion(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceRegion sets the ResourceRegion field's value.

func (*AwsSecurityFindingFilters) SetResourceTags 

func (s *AwsSecurityFindingFilters) SetResourceTags(v []*MapFilter) *AwsSecurityFindingFilters

SetResourceTags sets the ResourceTags field's value.

func (*AwsSecurityFindingFilters) SetResourceType 

func (s *AwsSecurityFindingFilters) SetResourceType(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceType sets the ResourceType field's value.

func (*AwsSecurityFindingFilters) SetSample added in v1.42.42 

func (s *AwsSecurityFindingFilters) SetSample(v []*BooleanFilter) *AwsSecurityFindingFilters

SetSample sets the Sample field's value.

func (*AwsSecurityFindingFilters) SetSeverityLabel 

func (s *AwsSecurityFindingFilters) SetSeverityLabel(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetSeverityProduct(v []*NumberFilter) *AwsSecurityFindingFilters

SetSeverityProduct sets the SeverityProduct field's value.

func (*AwsSecurityFindingFilters) SetSourceUrl 

func (s *AwsSecurityFindingFilters) SetSourceUrl(v []*StringFilter) *AwsSecurityFindingFilters

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 

func (s *AwsSecurityFindingFilters) SetTitle(v []*StringFilter) *AwsSecurityFindingFilters

SetTitle sets the Title field's value.

func (*AwsSecurityFindingFilters) SetType 

func (s *AwsSecurityFindingFilters) SetType(v []*StringFilter) *AwsSecurityFindingFilters

SetType sets the Type field's value.

func (*AwsSecurityFindingFilters) SetUpdatedAt 

func (s *AwsSecurityFindingFilters) SetUpdatedAt(v []*DateFilter) *AwsSecurityFindingFilters

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) SetVulnerabilitiesExploitAvailable added in v1.48.4 

func (s *AwsSecurityFindingFilters) SetVulnerabilitiesExploitAvailable(v []*StringFilter) *AwsSecurityFindingFilters

SetVulnerabilitiesExploitAvailable sets the VulnerabilitiesExploitAvailable field's value.

func (*AwsSecurityFindingFilters) SetVulnerabilitiesFixAvailable added in v1.48.4 

func (s *AwsSecurityFindingFilters) SetVulnerabilitiesFixAvailable(v []*StringFilter) *AwsSecurityFindingFilters

SetVulnerabilitiesFixAvailable sets the VulnerabilitiesFixAvailable field's value.

func (*AwsSecurityFindingFilters) SetWorkflowState 

func (s *AwsSecurityFindingFilters) SetWorkflowState(v []*StringFilter) *AwsSecurityFindingFilters

SetWorkflowState sets the WorkflowState field's value.

func (*AwsSecurityFindingFilters) SetWorkflowStatus added in v1.29.23 

func (s *AwsSecurityFindingFilters) SetWorkflowStatus(v []*StringFilter) *AwsSecurityFindingFilters

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 added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

func (s *AwsSecurityFindingIdentifier) SetId(v string) *AwsSecurityFindingIdentifier

SetId sets the Id field's value.

func (*AwsSecurityFindingIdentifier) SetProductArn added in v1.30.8 

func (s *AwsSecurityFindingIdentifier) SetProductArn(v string) *AwsSecurityFindingIdentifier

SetProductArn sets the ProductArn field's value.

func (AwsSecurityFindingIdentifier) String added in v1.30.8 

func (s AwsSecurityFindingIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.30.8 

func (s *AwsSecurityFindingIdentifier) Validate() error

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

type AwsSnsTopicDetails added in v1.26.7 

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 added in v1.26.7 

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.44.36 

func (s *AwsSnsTopicDetails) SetApplicationSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetApplicationSuccessFeedbackRoleArn sets the ApplicationSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetFirehoseFailureFeedbackRoleArn added in v1.44.36 

func (s *AwsSnsTopicDetails) SetFirehoseFailureFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetFirehoseFailureFeedbackRoleArn sets the FirehoseFailureFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetFirehoseSuccessFeedbackRoleArn added in v1.44.36 

func (s *AwsSnsTopicDetails) SetFirehoseSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetFirehoseSuccessFeedbackRoleArn sets the FirehoseSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetHttpFailureFeedbackRoleArn added in v1.44.36 

func (s *AwsSnsTopicDetails) SetHttpFailureFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetHttpFailureFeedbackRoleArn sets the HttpFailureFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetHttpSuccessFeedbackRoleArn added in v1.44.36 

func (s *AwsSnsTopicDetails) SetHttpSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetHttpSuccessFeedbackRoleArn sets the HttpSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetKmsMasterKeyId added in v1.26.7 

func (s *AwsSnsTopicDetails) SetKmsMasterKeyId(v string) *AwsSnsTopicDetails

SetKmsMasterKeyId sets the KmsMasterKeyId field's value.

func (*AwsSnsTopicDetails) SetOwner added in v1.26.7 

func (s *AwsSnsTopicDetails) SetOwner(v string) *AwsSnsTopicDetails

SetOwner sets the Owner field's value.

func (*AwsSnsTopicDetails) SetSqsFailureFeedbackRoleArn added in v1.44.36 

func (s *AwsSnsTopicDetails) SetSqsFailureFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetSqsFailureFeedbackRoleArn sets the SqsFailureFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetSqsSuccessFeedbackRoleArn added in v1.44.36 

func (s *AwsSnsTopicDetails) SetSqsSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetSqsSuccessFeedbackRoleArn sets the SqsSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetSubscription added in v1.26.7 

func (s *AwsSnsTopicDetails) SetSubscription(v []*AwsSnsTopicSubscription) *AwsSnsTopicDetails

SetSubscription sets the Subscription field's value.

func (*AwsSnsTopicDetails) SetTopicName added in v1.26.7 

func (s *AwsSnsTopicDetails) SetTopicName(v string) *AwsSnsTopicDetails

SetTopicName sets the TopicName field's value.

func (AwsSnsTopicDetails) String added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsSnsTopicSubscription) SetEndpoint(v string) *AwsSnsTopicSubscription

SetEndpoint sets the Endpoint field's value.

func (*AwsSnsTopicSubscription) SetProtocol added in v1.26.7 

func (s *AwsSnsTopicSubscription) SetProtocol(v string) *AwsSnsTopicSubscription

SetProtocol sets the Protocol field's value.

func (AwsSnsTopicSubscription) String added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *AwsSqsQueueDetails) SetDeadLetterTargetArn(v string) *AwsSqsQueueDetails

SetDeadLetterTargetArn sets the DeadLetterTargetArn field's value.

func (*AwsSqsQueueDetails) SetKmsDataKeyReusePeriodSeconds added in v1.26.7 

func (s *AwsSqsQueueDetails) SetKmsDataKeyReusePeriodSeconds(v int64) *AwsSqsQueueDetails

SetKmsDataKeyReusePeriodSeconds sets the KmsDataKeyReusePeriodSeconds field's value.

func (*AwsSqsQueueDetails) SetKmsMasterKeyId added in v1.26.7 

func (s *AwsSqsQueueDetails) SetKmsMasterKeyId(v string) *AwsSqsQueueDetails

SetKmsMasterKeyId sets the KmsMasterKeyId field's value.

func (*AwsSqsQueueDetails) SetQueueName added in v1.26.7 

func (s *AwsSqsQueueDetails) SetQueueName(v string) *AwsSqsQueueDetails

SetQueueName sets the QueueName field's value.

func (AwsSqsQueueDetails) String added in v1.26.7 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetComplianceType(v string) *AwsSsmComplianceSummary

SetComplianceType sets the ComplianceType field's value.

func (*AwsSsmComplianceSummary) SetCompliantCriticalCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetCompliantCriticalCount(v int64) *AwsSsmComplianceSummary

SetCompliantCriticalCount sets the CompliantCriticalCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantHighCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetCompliantHighCount(v int64) *AwsSsmComplianceSummary

SetCompliantHighCount sets the CompliantHighCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantInformationalCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetCompliantInformationalCount(v int64) *AwsSsmComplianceSummary

SetCompliantInformationalCount sets the CompliantInformationalCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantLowCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetCompliantLowCount(v int64) *AwsSsmComplianceSummary

SetCompliantLowCount sets the CompliantLowCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantMediumCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetCompliantMediumCount(v int64) *AwsSsmComplianceSummary

SetCompliantMediumCount sets the CompliantMediumCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantUnspecifiedCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetCompliantUnspecifiedCount(v int64) *AwsSsmComplianceSummary

SetCompliantUnspecifiedCount sets the CompliantUnspecifiedCount field's value.

func (*AwsSsmComplianceSummary) SetExecutionType added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetExecutionType(v string) *AwsSsmComplianceSummary

SetExecutionType sets the ExecutionType field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantCriticalCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetNonCompliantCriticalCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantCriticalCount sets the NonCompliantCriticalCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantHighCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetNonCompliantHighCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantHighCount sets the NonCompliantHighCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantInformationalCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetNonCompliantInformationalCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantInformationalCount sets the NonCompliantInformationalCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantLowCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetNonCompliantLowCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantLowCount sets the NonCompliantLowCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantMediumCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetNonCompliantMediumCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantMediumCount sets the NonCompliantMediumCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantUnspecifiedCount added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetNonCompliantUnspecifiedCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantUnspecifiedCount sets the NonCompliantUnspecifiedCount field's value.

func (*AwsSsmComplianceSummary) SetOverallSeverity added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetOverallSeverity(v string) *AwsSsmComplianceSummary

SetOverallSeverity sets the OverallSeverity field's value.

func (*AwsSsmComplianceSummary) SetPatchBaselineId added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetPatchBaselineId(v string) *AwsSsmComplianceSummary

SetPatchBaselineId sets the PatchBaselineId field's value.

func (*AwsSsmComplianceSummary) SetPatchGroup added in v1.36.30 

func (s *AwsSsmComplianceSummary) SetPatchGroup(v string) *AwsSsmComplianceSummary

SetPatchGroup sets the PatchGroup field's value.

func (*AwsSsmComplianceSummary) SetStatus added in v1.36.30 

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

SetStatus sets the Status field's value.

func (AwsSsmComplianceSummary) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *AwsSsmPatch) SetComplianceSummary(v *AwsSsmComplianceSummary) *AwsSsmPatch

SetComplianceSummary sets the ComplianceSummary field's value.

func (AwsSsmPatch) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *AwsSsmPatchComplianceDetails) SetPatch(v *AwsSsmPatch) *AwsSsmPatchComplianceDetails

SetPatch sets the Patch field's value.

func (AwsSsmPatchComplianceDetails) String added in v1.36.30 

func (s AwsSsmPatchComplianceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsStepFunctionStateMachineDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsStepFunctionStateMachineDetails) SetLabel(v string) *AwsStepFunctionStateMachineDetails

SetLabel sets the Label field's value.

func (*AwsStepFunctionStateMachineDetails) SetLoggingConfiguration added in v1.44.272 

func (s *AwsStepFunctionStateMachineDetails) SetLoggingConfiguration(v *AwsStepFunctionStateMachineLoggingConfigurationDetails) *AwsStepFunctionStateMachineDetails

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*AwsStepFunctionStateMachineDetails) SetName added in v1.44.272 

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

SetName sets the Name field's value.

func (*AwsStepFunctionStateMachineDetails) SetRoleArn added in v1.44.272 

func (s *AwsStepFunctionStateMachineDetails) SetRoleArn(v string) *AwsStepFunctionStateMachineDetails

SetRoleArn sets the RoleArn field's value.

func (*AwsStepFunctionStateMachineDetails) SetStateMachineArn added in v1.44.272 

func (s *AwsStepFunctionStateMachineDetails) SetStateMachineArn(v string) *AwsStepFunctionStateMachineDetails

SetStateMachineArn sets the StateMachineArn field's value.

func (*AwsStepFunctionStateMachineDetails) SetStatus added in v1.44.272 

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

SetStatus sets the Status field's value.

func (*AwsStepFunctionStateMachineDetails) SetTracingConfiguration added in v1.44.272 

func (s *AwsStepFunctionStateMachineDetails) SetTracingConfiguration(v *AwsStepFunctionStateMachineTracingConfigurationDetails) *AwsStepFunctionStateMachineDetails

SetTracingConfiguration sets the TracingConfiguration field's value.

func (*AwsStepFunctionStateMachineDetails) SetType added in v1.44.272 

func (s *AwsStepFunctionStateMachineDetails) SetType(v string) *AwsStepFunctionStateMachineDetails

SetType sets the Type field's value.

func (AwsStepFunctionStateMachineDetails) String added in v1.44.272 

func (s AwsStepFunctionStateMachineDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) SetLogGroupArn(v string) *AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails

SetLogGroupArn sets the LogGroupArn field's value.

func (AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) String added in v1.44.272 

func (s AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) SetCloudWatchLogsLogGroup(v *AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) *AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails

SetCloudWatchLogsLogGroup sets the CloudWatchLogsLogGroup field's value.

func (AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) String added in v1.44.272 

func (s AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsStepFunctionStateMachineLoggingConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsStepFunctionStateMachineLoggingConfigurationDetails) SetDestinations(v []*AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) *AwsStepFunctionStateMachineLoggingConfigurationDetails

SetDestinations sets the Destinations field's value.

func (*AwsStepFunctionStateMachineLoggingConfigurationDetails) SetIncludeExecutionData added in v1.44.272 

func (s *AwsStepFunctionStateMachineLoggingConfigurationDetails) SetIncludeExecutionData(v bool) *AwsStepFunctionStateMachineLoggingConfigurationDetails

SetIncludeExecutionData sets the IncludeExecutionData field's value.

func (*AwsStepFunctionStateMachineLoggingConfigurationDetails) SetLevel added in v1.44.272 

func (s *AwsStepFunctionStateMachineLoggingConfigurationDetails) SetLevel(v string) *AwsStepFunctionStateMachineLoggingConfigurationDetails

SetLevel sets the Level field's value.

func (AwsStepFunctionStateMachineLoggingConfigurationDetails) String added in v1.44.272 

func (s AwsStepFunctionStateMachineLoggingConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

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.44.272 

func (s AwsStepFunctionStateMachineTracingConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.272 

func (s *AwsStepFunctionStateMachineTracingConfigurationDetails) SetEnabled(v bool) *AwsStepFunctionStateMachineTracingConfigurationDetails

SetEnabled sets the Enabled field's value.

func (AwsStepFunctionStateMachineTracingConfigurationDetails) String added in v1.44.272 

func (s AwsStepFunctionStateMachineTracingConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

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 added in v1.40.59 

func (s *AwsWafRateBasedRuleDetails) SetMatchPredicates(v []*AwsWafRateBasedRuleMatchPredicate) *AwsWafRateBasedRuleDetails

SetMatchPredicates sets the MatchPredicates field's value.

func (*AwsWafRateBasedRuleDetails) SetMetricName added in v1.40.59 

func (s *AwsWafRateBasedRuleDetails) SetMetricName(v string) *AwsWafRateBasedRuleDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRateBasedRuleDetails) SetName added in v1.40.59 

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

SetName sets the Name field's value.

func (*AwsWafRateBasedRuleDetails) SetRateKey added in v1.40.59 

func (s *AwsWafRateBasedRuleDetails) SetRateKey(v string) *AwsWafRateBasedRuleDetails

SetRateKey sets the RateKey field's value.

func (*AwsWafRateBasedRuleDetails) SetRateLimit added in v1.40.59 

func (s *AwsWafRateBasedRuleDetails) SetRateLimit(v int64) *AwsWafRateBasedRuleDetails

SetRateLimit sets the RateLimit field's value.

func (*AwsWafRateBasedRuleDetails) SetRuleId added in v1.40.59 

func (s *AwsWafRateBasedRuleDetails) SetRuleId(v string) *AwsWafRateBasedRuleDetails

SetRuleId sets the RuleId field's value.

func (AwsWafRateBasedRuleDetails) String added in v1.40.59 

func (s AwsWafRateBasedRuleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsWafRateBasedRuleMatchPredicate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsWafRateBasedRuleMatchPredicate) SetDataId(v string) *AwsWafRateBasedRuleMatchPredicate

SetDataId sets the DataId field's value.

func (*AwsWafRateBasedRuleMatchPredicate) SetNegated added in v1.40.59 

func (s *AwsWafRateBasedRuleMatchPredicate) SetNegated(v bool) *AwsWafRateBasedRuleMatchPredicate

SetNegated sets the Negated field's value.

func (*AwsWafRateBasedRuleMatchPredicate) SetType added in v1.40.59 

func (s *AwsWafRateBasedRuleMatchPredicate) SetType(v string) *AwsWafRateBasedRuleMatchPredicate

SetType sets the Type field's value.

func (AwsWafRateBasedRuleMatchPredicate) String added in v1.40.59 

func (s AwsWafRateBasedRuleMatchPredicate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsWafRegionalRateBasedRuleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleDetails) SetMatchPredicates(v []*AwsWafRegionalRateBasedRuleMatchPredicate) *AwsWafRegionalRateBasedRuleDetails

SetMatchPredicates sets the MatchPredicates field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetMetricName added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleDetails) SetMetricName(v string) *AwsWafRegionalRateBasedRuleDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetName added in v1.40.59 

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

SetName sets the Name field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetRateKey added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleDetails) SetRateKey(v string) *AwsWafRegionalRateBasedRuleDetails

SetRateKey sets the RateKey field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetRateLimit added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleDetails) SetRateLimit(v int64) *AwsWafRegionalRateBasedRuleDetails

SetRateLimit sets the RateLimit field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetRuleId added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleDetails) SetRuleId(v string) *AwsWafRegionalRateBasedRuleDetails

SetRuleId sets the RuleId field's value.

func (AwsWafRegionalRateBasedRuleDetails) String added in v1.40.59 

func (s AwsWafRegionalRateBasedRuleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsWafRegionalRateBasedRuleMatchPredicate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleMatchPredicate) SetDataId(v string) *AwsWafRegionalRateBasedRuleMatchPredicate

SetDataId sets the DataId field's value.

func (*AwsWafRegionalRateBasedRuleMatchPredicate) SetNegated added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleMatchPredicate) SetNegated(v bool) *AwsWafRegionalRateBasedRuleMatchPredicate

SetNegated sets the Negated field's value.

func (*AwsWafRegionalRateBasedRuleMatchPredicate) SetType added in v1.40.59 

func (s *AwsWafRegionalRateBasedRuleMatchPredicate) SetType(v string) *AwsWafRegionalRateBasedRuleMatchPredicate

SetType sets the Type field's value.

func (AwsWafRegionalRateBasedRuleMatchPredicate) String added in v1.40.59 

func (s AwsWafRegionalRateBasedRuleMatchPredicate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsWafRegionalRuleDetails) SetMetricName(v string) *AwsWafRegionalRuleDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalRuleDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsWafRegionalRuleDetails) SetPredicateList added in v1.44.36 

func (s *AwsWafRegionalRuleDetails) SetPredicateList(v []*AwsWafRegionalRulePredicateListDetails) *AwsWafRegionalRuleDetails

SetPredicateList sets the PredicateList field's value.

func (*AwsWafRegionalRuleDetails) SetRuleId added in v1.44.36 

func (s *AwsWafRegionalRuleDetails) SetRuleId(v string) *AwsWafRegionalRuleDetails

SetRuleId sets the RuleId field's value.

func (AwsWafRegionalRuleDetails) String added in v1.44.36 

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.44.36 

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.44.36 

func (s AwsWafRegionalRuleGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalRuleGroupDetails) SetMetricName(v string) *AwsWafRegionalRuleGroupDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalRuleGroupDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsWafRegionalRuleGroupDetails) SetRuleGroupId added in v1.44.36 

func (s *AwsWafRegionalRuleGroupDetails) SetRuleGroupId(v string) *AwsWafRegionalRuleGroupDetails

SetRuleGroupId sets the RuleGroupId field's value.

func (*AwsWafRegionalRuleGroupDetails) SetRules added in v1.44.36 

func (s *AwsWafRegionalRuleGroupDetails) SetRules(v []*AwsWafRegionalRuleGroupRulesDetails) *AwsWafRegionalRuleGroupDetails

SetRules sets the Rules field's value.

func (AwsWafRegionalRuleGroupDetails) String added in v1.44.36 

func (s AwsWafRegionalRuleGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRegionalRuleGroupRulesActionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalRuleGroupRulesActionDetails) SetType(v string) *AwsWafRegionalRuleGroupRulesActionDetails

SetType sets the Type field's value.

func (AwsWafRegionalRuleGroupRulesActionDetails) String added in v1.44.36 

func (s AwsWafRegionalRuleGroupRulesActionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRegionalRuleGroupRulesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalRuleGroupRulesDetails) SetAction(v *AwsWafRegionalRuleGroupRulesActionDetails) *AwsWafRegionalRuleGroupRulesDetails

SetAction sets the Action field's value.

func (*AwsWafRegionalRuleGroupRulesDetails) SetPriority added in v1.44.36 

func (s *AwsWafRegionalRuleGroupRulesDetails) SetPriority(v int64) *AwsWafRegionalRuleGroupRulesDetails

SetPriority sets the Priority field's value.

func (*AwsWafRegionalRuleGroupRulesDetails) SetRuleId added in v1.44.36 

func (s *AwsWafRegionalRuleGroupRulesDetails) SetRuleId(v string) *AwsWafRegionalRuleGroupRulesDetails

SetRuleId sets the RuleId field's value.

func (*AwsWafRegionalRuleGroupRulesDetails) SetType added in v1.44.36 

func (s *AwsWafRegionalRuleGroupRulesDetails) SetType(v string) *AwsWafRegionalRuleGroupRulesDetails

SetType sets the Type field's value.

func (AwsWafRegionalRuleGroupRulesDetails) String added in v1.44.36 

func (s AwsWafRegionalRuleGroupRulesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRegionalRulePredicateListDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalRulePredicateListDetails) SetDataId(v string) *AwsWafRegionalRulePredicateListDetails

SetDataId sets the DataId field's value.

func (*AwsWafRegionalRulePredicateListDetails) SetNegated added in v1.44.36 

func (s *AwsWafRegionalRulePredicateListDetails) SetNegated(v bool) *AwsWafRegionalRulePredicateListDetails

SetNegated sets the Negated field's value.

func (*AwsWafRegionalRulePredicateListDetails) SetType added in v1.44.36 

func (s *AwsWafRegionalRulePredicateListDetails) SetType(v string) *AwsWafRegionalRulePredicateListDetails

SetType sets the Type field's value.

func (AwsWafRegionalRulePredicateListDetails) String added in v1.44.36 

func (s AwsWafRegionalRulePredicateListDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsWafRegionalWebAclDetails) SetDefaultAction(v string) *AwsWafRegionalWebAclDetails

SetDefaultAction sets the DefaultAction field's value.

func (*AwsWafRegionalWebAclDetails) SetMetricName added in v1.44.36 

func (s *AwsWafRegionalWebAclDetails) SetMetricName(v string) *AwsWafRegionalWebAclDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalWebAclDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsWafRegionalWebAclDetails) SetRulesList added in v1.44.36 

func (s *AwsWafRegionalWebAclDetails) SetRulesList(v []*AwsWafRegionalWebAclRulesListDetails) *AwsWafRegionalWebAclDetails

SetRulesList sets the RulesList field's value.

func (*AwsWafRegionalWebAclDetails) SetWebAclId added in v1.44.36 

func (s *AwsWafRegionalWebAclDetails) SetWebAclId(v string) *AwsWafRegionalWebAclDetails

SetWebAclId sets the WebAclId field's value.

func (AwsWafRegionalWebAclDetails) String added in v1.44.36 

func (s AwsWafRegionalWebAclDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRegionalWebAclRulesListActionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalWebAclRulesListActionDetails) SetType(v string) *AwsWafRegionalWebAclRulesListActionDetails

SetType sets the Type field's value.

func (AwsWafRegionalWebAclRulesListActionDetails) String added in v1.44.36 

func (s AwsWafRegionalWebAclRulesListActionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRegionalWebAclRulesListDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalWebAclRulesListDetails) SetAction(v *AwsWafRegionalWebAclRulesListActionDetails) *AwsWafRegionalWebAclRulesListDetails

SetAction sets the Action field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetOverrideAction added in v1.44.36 

func (s *AwsWafRegionalWebAclRulesListDetails) SetOverrideAction(v *AwsWafRegionalWebAclRulesListOverrideActionDetails) *AwsWafRegionalWebAclRulesListDetails

SetOverrideAction sets the OverrideAction field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetPriority added in v1.44.36 

func (s *AwsWafRegionalWebAclRulesListDetails) SetPriority(v int64) *AwsWafRegionalWebAclRulesListDetails

SetPriority sets the Priority field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetRuleId added in v1.44.36 

func (s *AwsWafRegionalWebAclRulesListDetails) SetRuleId(v string) *AwsWafRegionalWebAclRulesListDetails

SetRuleId sets the RuleId field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetType added in v1.44.36 

func (s *AwsWafRegionalWebAclRulesListDetails) SetType(v string) *AwsWafRegionalWebAclRulesListDetails

SetType sets the Type field's value.

func (AwsWafRegionalWebAclRulesListDetails) String added in v1.44.36 

func (s AwsWafRegionalWebAclRulesListDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRegionalWebAclRulesListOverrideActionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRegionalWebAclRulesListOverrideActionDetails) SetType(v string) *AwsWafRegionalWebAclRulesListOverrideActionDetails

SetType sets the Type field's value.

func (AwsWafRegionalWebAclRulesListOverrideActionDetails) String added in v1.44.36 

func (s AwsWafRegionalWebAclRulesListOverrideActionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsWafRuleDetails) SetMetricName(v string) *AwsWafRuleDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRuleDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsWafRuleDetails) SetPredicateList added in v1.44.36 

func (s *AwsWafRuleDetails) SetPredicateList(v []*AwsWafRulePredicateListDetails) *AwsWafRuleDetails

SetPredicateList sets the PredicateList field's value.

func (*AwsWafRuleDetails) SetRuleId added in v1.44.36 

func (s *AwsWafRuleDetails) SetRuleId(v string) *AwsWafRuleDetails

SetRuleId sets the RuleId field's value.

func (AwsWafRuleDetails) String added in v1.44.36 

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.44.36 

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.44.36 

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.44.36 

func (s *AwsWafRuleGroupDetails) SetMetricName(v string) *AwsWafRuleGroupDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRuleGroupDetails) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*AwsWafRuleGroupDetails) SetRuleGroupId added in v1.44.36 

func (s *AwsWafRuleGroupDetails) SetRuleGroupId(v string) *AwsWafRuleGroupDetails

SetRuleGroupId sets the RuleGroupId field's value.

func (*AwsWafRuleGroupDetails) SetRules added in v1.44.36 

func (s *AwsWafRuleGroupDetails) SetRules(v []*AwsWafRuleGroupRulesDetails) *AwsWafRuleGroupDetails

SetRules sets the Rules field's value.

func (AwsWafRuleGroupDetails) String added in v1.44.36 

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.44.36 

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.44.36 

func (s AwsWafRuleGroupRulesActionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRuleGroupRulesActionDetails) SetType(v string) *AwsWafRuleGroupRulesActionDetails

SetType sets the Type field's value.

func (AwsWafRuleGroupRulesActionDetails) String added in v1.44.36 

func (s AwsWafRuleGroupRulesActionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *AwsWafRuleGroupRulesDetails) SetAction(v *AwsWafRuleGroupRulesActionDetails) *AwsWafRuleGroupRulesDetails

SetAction sets the Action field's value.

func (*AwsWafRuleGroupRulesDetails) SetPriority added in v1.44.36 

func (s *AwsWafRuleGroupRulesDetails) SetPriority(v int64) *AwsWafRuleGroupRulesDetails

SetPriority sets the Priority field's value.

func (*AwsWafRuleGroupRulesDetails) SetRuleId added in v1.44.36 

func (s *AwsWafRuleGroupRulesDetails) SetRuleId(v string) *AwsWafRuleGroupRulesDetails

SetRuleId sets the RuleId field's value.

func (*AwsWafRuleGroupRulesDetails) SetType added in v1.44.36 

func (s *AwsWafRuleGroupRulesDetails) SetType(v string) *AwsWafRuleGroupRulesDetails

SetType sets the Type field's value.

func (AwsWafRuleGroupRulesDetails) String added in v1.44.36 

func (s AwsWafRuleGroupRulesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s AwsWafRulePredicateListDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *AwsWafRulePredicateListDetails) SetDataId(v string) *AwsWafRulePredicateListDetails

SetDataId sets the DataId field's value.

func (*AwsWafRulePredicateListDetails) SetNegated added in v1.44.36 

func (s *AwsWafRulePredicateListDetails) SetNegated(v bool) *AwsWafRulePredicateListDetails

SetNegated sets the Negated field's value.

func (*AwsWafRulePredicateListDetails) SetType added in v1.44.36 

func (s *AwsWafRulePredicateListDetails) SetType(v string) *AwsWafRulePredicateListDetails

SetType sets the Type field's value.

func (AwsWafRulePredicateListDetails) String added in v1.44.36 

func (s AwsWafRulePredicateListDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsWafWebAclDetails) SetDefaultAction(v string) *AwsWafWebAclDetails

SetDefaultAction sets the DefaultAction field's value.

func (*AwsWafWebAclDetails) SetName added in v1.28.11 

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

SetName sets the Name field's value.

func (*AwsWafWebAclDetails) SetRules added in v1.28.11 

func (s *AwsWafWebAclDetails) SetRules(v []*AwsWafWebAclRule) *AwsWafWebAclDetails

SetRules sets the Rules field's value.

func (*AwsWafWebAclDetails) SetWebAclId added in v1.28.11 

func (s *AwsWafWebAclDetails) SetWebAclId(v string) *AwsWafWebAclDetails

SetWebAclId sets the WebAclId field's value.

func (AwsWafWebAclDetails) String added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *AwsWafWebAclRule) SetAction(v *WafAction) *AwsWafWebAclRule

SetAction sets the Action field's value.

func (*AwsWafWebAclRule) SetExcludedRules added in v1.28.11 

func (s *AwsWafWebAclRule) SetExcludedRules(v []*WafExcludedRule) *AwsWafWebAclRule

SetExcludedRules sets the ExcludedRules field's value.

func (*AwsWafWebAclRule) SetOverrideAction added in v1.28.11 

func (s *AwsWafWebAclRule) SetOverrideAction(v *WafOverrideAction) *AwsWafWebAclRule

SetOverrideAction sets the OverrideAction field's value.

func (*AwsWafWebAclRule) SetPriority added in v1.28.11 

func (s *AwsWafWebAclRule) SetPriority(v int64) *AwsWafWebAclRule

SetPriority sets the Priority field's value.

func (*AwsWafWebAclRule) SetRuleId added in v1.28.11 

func (s *AwsWafWebAclRule) SetRuleId(v string) *AwsWafWebAclRule

SetRuleId sets the RuleId field's value.

func (*AwsWafWebAclRule) SetType added in v1.28.11 

func (s *AwsWafWebAclRule) SetType(v string) *AwsWafWebAclRule

SetType sets the Type field's value.

func (AwsWafWebAclRule) String added in v1.28.11 

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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2ActionAllowDetails) SetCustomRequestHandling(v *AwsWafv2CustomRequestHandlingDetails) *AwsWafv2ActionAllowDetails

SetCustomRequestHandling sets the CustomRequestHandling field's value.

func (AwsWafv2ActionAllowDetails) String added in v1.44.161 

func (s AwsWafv2ActionAllowDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2ActionBlockDetails) SetCustomResponse(v *AwsWafv2CustomResponseDetails) *AwsWafv2ActionBlockDetails

SetCustomResponse sets the CustomResponse field's value.

func (AwsWafv2ActionBlockDetails) String added in v1.44.161 

func (s AwsWafv2ActionBlockDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

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

SetName sets the Name field's value.

func (*AwsWafv2CustomHttpHeader) SetValue added in v1.44.161 

func (s *AwsWafv2CustomHttpHeader) SetValue(v string) *AwsWafv2CustomHttpHeader

SetValue sets the Value field's value.

func (AwsWafv2CustomHttpHeader) String added in v1.44.161 

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.44.161 

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.44.161 

func (s AwsWafv2CustomRequestHandlingDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2CustomRequestHandlingDetails) SetInsertHeaders(v []*AwsWafv2CustomHttpHeader) *AwsWafv2CustomRequestHandlingDetails

SetInsertHeaders sets the InsertHeaders field's value.

func (AwsWafv2CustomRequestHandlingDetails) String added in v1.44.161 

func (s AwsWafv2CustomRequestHandlingDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsWafv2CustomResponseDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2CustomResponseDetails) SetCustomResponseBodyKey(v string) *AwsWafv2CustomResponseDetails

SetCustomResponseBodyKey sets the CustomResponseBodyKey field's value.

func (*AwsWafv2CustomResponseDetails) SetResponseCode added in v1.44.161 

func (s *AwsWafv2CustomResponseDetails) SetResponseCode(v int64) *AwsWafv2CustomResponseDetails

SetResponseCode sets the ResponseCode field's value.

func (*AwsWafv2CustomResponseDetails) SetResponseHeaders added in v1.44.161 

func (s *AwsWafv2CustomResponseDetails) SetResponseHeaders(v []*AwsWafv2CustomHttpHeader) *AwsWafv2CustomResponseDetails

SetResponseHeaders sets the ResponseHeaders field's value.

func (AwsWafv2CustomResponseDetails) String added in v1.44.161 

func (s AwsWafv2CustomResponseDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2RuleGroupDetails) SetArn(v string) *AwsWafv2RuleGroupDetails

SetArn sets the Arn field's value.

func (*AwsWafv2RuleGroupDetails) SetCapacity added in v1.44.161 

func (s *AwsWafv2RuleGroupDetails) SetCapacity(v int64) *AwsWafv2RuleGroupDetails

SetCapacity sets the Capacity field's value.

func (*AwsWafv2RuleGroupDetails) SetDescription added in v1.44.161 

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

SetDescription sets the Description field's value.

func (*AwsWafv2RuleGroupDetails) SetId added in v1.44.161 

func (s *AwsWafv2RuleGroupDetails) SetId(v string) *AwsWafv2RuleGroupDetails

SetId sets the Id field's value.

func (*AwsWafv2RuleGroupDetails) SetName added in v1.44.161 

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

SetName sets the Name field's value.

func (*AwsWafv2RuleGroupDetails) SetRules added in v1.44.161 

func (s *AwsWafv2RuleGroupDetails) SetRules(v []*AwsWafv2RulesDetails) *AwsWafv2RuleGroupDetails

SetRules sets the Rules field's value.

func (*AwsWafv2RuleGroupDetails) SetScope added in v1.44.161 

func (s *AwsWafv2RuleGroupDetails) SetScope(v string) *AwsWafv2RuleGroupDetails

SetScope sets the Scope field's value.

func (*AwsWafv2RuleGroupDetails) SetVisibilityConfig added in v1.44.161 

func (s *AwsWafv2RuleGroupDetails) SetVisibilityConfig(v *AwsWafv2VisibilityConfigDetails) *AwsWafv2RuleGroupDetails

SetVisibilityConfig sets the VisibilityConfig field's value.

func (AwsWafv2RuleGroupDetails) String added in v1.44.161 

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.44.161 

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.44.161 

func (s AwsWafv2RulesActionCaptchaDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2RulesActionCaptchaDetails) SetCustomRequestHandling(v *AwsWafv2CustomRequestHandlingDetails) *AwsWafv2RulesActionCaptchaDetails

SetCustomRequestHandling sets the CustomRequestHandling field's value.

func (AwsWafv2RulesActionCaptchaDetails) String added in v1.44.161 

func (s AwsWafv2RulesActionCaptchaDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsWafv2RulesActionCountDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2RulesActionCountDetails) SetCustomRequestHandling(v *AwsWafv2CustomRequestHandlingDetails) *AwsWafv2RulesActionCountDetails

SetCustomRequestHandling sets the CustomRequestHandling field's value.

func (AwsWafv2RulesActionCountDetails) String added in v1.44.161 

func (s AwsWafv2RulesActionCountDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2RulesActionDetails) SetAllow(v *AwsWafv2ActionAllowDetails) *AwsWafv2RulesActionDetails

SetAllow sets the Allow field's value.

func (*AwsWafv2RulesActionDetails) SetBlock added in v1.44.161 

func (s *AwsWafv2RulesActionDetails) SetBlock(v *AwsWafv2ActionBlockDetails) *AwsWafv2RulesActionDetails

SetBlock sets the Block field's value.

func (*AwsWafv2RulesActionDetails) SetCaptcha added in v1.44.161 

func (s *AwsWafv2RulesActionDetails) SetCaptcha(v *AwsWafv2RulesActionCaptchaDetails) *AwsWafv2RulesActionDetails

SetCaptcha sets the Captcha field's value.

func (*AwsWafv2RulesActionDetails) SetCount added in v1.44.161 

func (s *AwsWafv2RulesActionDetails) SetCount(v *AwsWafv2RulesActionCountDetails) *AwsWafv2RulesActionDetails

SetCount sets the Count field's value.

func (AwsWafv2RulesActionDetails) String added in v1.44.161 

func (s AwsWafv2RulesActionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2RulesDetails) SetAction(v *AwsWafv2RulesActionDetails) *AwsWafv2RulesDetails

SetAction sets the Action field's value.

func (*AwsWafv2RulesDetails) SetName added in v1.44.161 

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

SetName sets the Name field's value.

func (*AwsWafv2RulesDetails) SetOverrideAction added in v1.44.161 

func (s *AwsWafv2RulesDetails) SetOverrideAction(v string) *AwsWafv2RulesDetails

SetOverrideAction sets the OverrideAction field's value.

func (*AwsWafv2RulesDetails) SetPriority added in v1.44.161 

func (s *AwsWafv2RulesDetails) SetPriority(v int64) *AwsWafv2RulesDetails

SetPriority sets the Priority field's value.

func (*AwsWafv2RulesDetails) SetVisibilityConfig added in v1.44.161 

func (s *AwsWafv2RulesDetails) SetVisibilityConfig(v *AwsWafv2VisibilityConfigDetails) *AwsWafv2RulesDetails

SetVisibilityConfig sets the VisibilityConfig field's value.

func (AwsWafv2RulesDetails) String added in v1.44.161 

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.44.161 

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.44.161 

func (s AwsWafv2VisibilityConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2VisibilityConfigDetails) SetCloudWatchMetricsEnabled(v bool) *AwsWafv2VisibilityConfigDetails

SetCloudWatchMetricsEnabled sets the CloudWatchMetricsEnabled field's value.

func (*AwsWafv2VisibilityConfigDetails) SetMetricName added in v1.44.161 

func (s *AwsWafv2VisibilityConfigDetails) SetMetricName(v string) *AwsWafv2VisibilityConfigDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafv2VisibilityConfigDetails) SetSampledRequestsEnabled added in v1.44.161 

func (s *AwsWafv2VisibilityConfigDetails) SetSampledRequestsEnabled(v bool) *AwsWafv2VisibilityConfigDetails

SetSampledRequestsEnabled sets the SampledRequestsEnabled field's value.

func (AwsWafv2VisibilityConfigDetails) String added in v1.44.161 

func (s AwsWafv2VisibilityConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2WebAclActionDetails) SetAllow(v *AwsWafv2ActionAllowDetails) *AwsWafv2WebAclActionDetails

SetAllow sets the Allow field's value.

func (*AwsWafv2WebAclActionDetails) SetBlock added in v1.44.161 

func (s *AwsWafv2WebAclActionDetails) SetBlock(v *AwsWafv2ActionBlockDetails) *AwsWafv2WebAclActionDetails

SetBlock sets the Block field's value.

func (AwsWafv2WebAclActionDetails) String added in v1.44.161 

func (s AwsWafv2WebAclActionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsWafv2WebAclCaptchaConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2WebAclCaptchaConfigDetails) SetImmunityTimeProperty(v *AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) *AwsWafv2WebAclCaptchaConfigDetails

SetImmunityTimeProperty sets the ImmunityTimeProperty field's value.

func (AwsWafv2WebAclCaptchaConfigDetails) String added in v1.44.161 

func (s AwsWafv2WebAclCaptchaConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

func (s AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

func (s *AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) SetImmunityTime(v int64) *AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails

SetImmunityTime sets the ImmunityTime field's value.

func (AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) String added in v1.44.161 

func (s AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.161 

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.44.161 

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.44.161 

func (s *AwsWafv2WebAclDetails) SetArn(v string) *AwsWafv2WebAclDetails

SetArn sets the Arn field's value.

func (*AwsWafv2WebAclDetails) SetCapacity added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetCapacity(v int64) *AwsWafv2WebAclDetails

SetCapacity sets the Capacity field's value.

func (*AwsWafv2WebAclDetails) SetCaptchaConfig added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetCaptchaConfig(v *AwsWafv2WebAclCaptchaConfigDetails) *AwsWafv2WebAclDetails

SetCaptchaConfig sets the CaptchaConfig field's value.

func (*AwsWafv2WebAclDetails) SetDefaultAction added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetDefaultAction(v *AwsWafv2WebAclActionDetails) *AwsWafv2WebAclDetails

SetDefaultAction sets the DefaultAction field's value.

func (*AwsWafv2WebAclDetails) SetDescription added in v1.44.161 

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

SetDescription sets the Description field's value.

func (*AwsWafv2WebAclDetails) SetId added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetId(v string) *AwsWafv2WebAclDetails

SetId sets the Id field's value.

func (*AwsWafv2WebAclDetails) SetManagedbyFirewallManager added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetManagedbyFirewallManager(v bool) *AwsWafv2WebAclDetails

SetManagedbyFirewallManager sets the ManagedbyFirewallManager field's value.

func (*AwsWafv2WebAclDetails) SetName added in v1.44.161 

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

SetName sets the Name field's value.

func (*AwsWafv2WebAclDetails) SetRules added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetRules(v []*AwsWafv2RulesDetails) *AwsWafv2WebAclDetails

SetRules sets the Rules field's value.

func (*AwsWafv2WebAclDetails) SetVisibilityConfig added in v1.44.161 

func (s *AwsWafv2WebAclDetails) SetVisibilityConfig(v *AwsWafv2VisibilityConfigDetails) *AwsWafv2WebAclDetails

SetVisibilityConfig sets the VisibilityConfig field's value.

func (AwsWafv2WebAclDetails) String added in v1.44.161 

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 added in v1.40.59 

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 added in v1.40.59 

func (s AwsXrayEncryptionConfigDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.40.59 

func (s *AwsXrayEncryptionConfigDetails) SetKeyId(v string) *AwsXrayEncryptionConfigDetails

SetKeyId sets the KeyId field's value.

func (*AwsXrayEncryptionConfigDetails) SetStatus added in v1.40.59 

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

SetStatus sets the Status field's value.

func (*AwsXrayEncryptionConfigDetails) SetType added in v1.40.59 

func (s *AwsXrayEncryptionConfigDetails) SetType(v string) *AwsXrayEncryptionConfigDetails

SetType sets the Type field's value.

func (AwsXrayEncryptionConfigDetails) String added in v1.40.59 

func (s AwsXrayEncryptionConfigDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

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.44.282 

func (s BatchDeleteAutomationRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchDeleteAutomationRulesInput) SetAutomationRulesArns(v []*string) *BatchDeleteAutomationRulesInput

SetAutomationRulesArns sets the AutomationRulesArns field's value.

func (BatchDeleteAutomationRulesInput) String added in v1.44.282 

func (s BatchDeleteAutomationRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchDeleteAutomationRulesInput) Validate() error

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

type BatchDeleteAutomationRulesOutput added in v1.44.282 

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.44.282 

func (s BatchDeleteAutomationRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchDeleteAutomationRulesOutput) SetProcessedAutomationRules(v []*string) *BatchDeleteAutomationRulesOutput

SetProcessedAutomationRules sets the ProcessedAutomationRules field's value.

func (*BatchDeleteAutomationRulesOutput) SetUnprocessedAutomationRules added in v1.44.282 

func (s *BatchDeleteAutomationRulesOutput) SetUnprocessedAutomationRules(v []*UnprocessedAutomationRule) *BatchDeleteAutomationRulesOutput

SetUnprocessedAutomationRules sets the UnprocessedAutomationRules field's value.

func (BatchDeleteAutomationRulesOutput) String added in v1.44.282 

func (s BatchDeleteAutomationRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s BatchDisableStandardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *BatchDisableStandardsOutput) SetStandardsSubscriptions(v []*StandardsSubscription) *BatchDisableStandardsOutput

SetStandardsSubscriptions sets the StandardsSubscriptions field's value.

func (BatchDisableStandardsOutput) String 

func (s BatchDisableStandardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *BatchEnableStandardsOutput) SetStandardsSubscriptions(v []*StandardsSubscription) *BatchEnableStandardsOutput

SetStandardsSubscriptions sets the StandardsSubscriptions field's value.

func (BatchEnableStandardsOutput) String 

func (s BatchEnableStandardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

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.44.282 

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.44.282 

func (s *BatchGetAutomationRulesInput) SetAutomationRulesArns(v []*string) *BatchGetAutomationRulesInput

SetAutomationRulesArns sets the AutomationRulesArns field's value.

func (BatchGetAutomationRulesInput) String added in v1.44.282 

func (s BatchGetAutomationRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchGetAutomationRulesInput) Validate() error

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

type BatchGetAutomationRulesOutput added in v1.44.282 

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.44.282 

func (s BatchGetAutomationRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchGetAutomationRulesOutput) SetRules(v []*AutomationRulesConfig) *BatchGetAutomationRulesOutput

SetRules sets the Rules field's value.

func (*BatchGetAutomationRulesOutput) SetUnprocessedAutomationRules added in v1.44.282 

func (s *BatchGetAutomationRulesOutput) SetUnprocessedAutomationRules(v []*UnprocessedAutomationRule) *BatchGetAutomationRulesOutput

SetUnprocessedAutomationRules sets the UnprocessedAutomationRules field's value.

func (BatchGetAutomationRulesOutput) String added in v1.44.282 

func (s BatchGetAutomationRulesOutput) String() string

String returns the string representation.

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

type BatchGetConfigurationPolicyAssociationsInput added in v1.48.5 

type BatchGetConfigurationPolicyAssociationsInput struct {

	// Specifies one or more target account IDs, organizational unit (OU) IDs, or
	// the root ID to retrieve associations for.
	//
	// ConfigurationPolicyAssociationIdentifiers is a required field
	ConfigurationPolicyAssociationIdentifiers []*ConfigurationPolicyAssociation `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetConfigurationPolicyAssociationsInput) GoString added in v1.48.5 

func (s BatchGetConfigurationPolicyAssociationsInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetConfigurationPolicyAssociationsInput) SetConfigurationPolicyAssociationIdentifiers added in v1.48.5 

func (s *BatchGetConfigurationPolicyAssociationsInput) SetConfigurationPolicyAssociationIdentifiers(v []*ConfigurationPolicyAssociation) *BatchGetConfigurationPolicyAssociationsInput

SetConfigurationPolicyAssociationIdentifiers sets the ConfigurationPolicyAssociationIdentifiers field's value.

func (BatchGetConfigurationPolicyAssociationsInput) String added in v1.48.5 

func (s BatchGetConfigurationPolicyAssociationsInput) String() string

String returns the string representation.

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

func (*BatchGetConfigurationPolicyAssociationsInput) Validate added in v1.48.5 

func (s *BatchGetConfigurationPolicyAssociationsInput) Validate() error

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

type BatchGetConfigurationPolicyAssociationsOutput added in v1.48.5 

type BatchGetConfigurationPolicyAssociationsOutput struct {

	// Describes associations for the target accounts, OUs, or the root.
	ConfigurationPolicyAssociations []*ConfigurationPolicyAssociationSummary `type:"list"`

	// An array of configuration policy associations, one for each configuration
	// policy association identifier, that was specified in the request but couldn’t
	// be processed due to an error.
	UnprocessedConfigurationPolicyAssociations []*UnprocessedConfigurationPolicyAssociation `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetConfigurationPolicyAssociationsOutput) GoString added in v1.48.5 

func (s BatchGetConfigurationPolicyAssociationsOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetConfigurationPolicyAssociationsOutput) SetConfigurationPolicyAssociations added in v1.48.5 

func (s *BatchGetConfigurationPolicyAssociationsOutput) SetConfigurationPolicyAssociations(v []*ConfigurationPolicyAssociationSummary) *BatchGetConfigurationPolicyAssociationsOutput

SetConfigurationPolicyAssociations sets the ConfigurationPolicyAssociations field's value.

func (*BatchGetConfigurationPolicyAssociationsOutput) SetUnprocessedConfigurationPolicyAssociations added in v1.48.5 

func (s *BatchGetConfigurationPolicyAssociationsOutput) SetUnprocessedConfigurationPolicyAssociations(v []*UnprocessedConfigurationPolicyAssociation) *BatchGetConfigurationPolicyAssociationsOutput

SetUnprocessedConfigurationPolicyAssociations sets the UnprocessedConfigurationPolicyAssociations field's value.

func (BatchGetConfigurationPolicyAssociationsOutput) String added in v1.48.5 

func (s BatchGetConfigurationPolicyAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s BatchGetSecurityControlsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchGetSecurityControlsInput) SetSecurityControlIds(v []*string) *BatchGetSecurityControlsInput

SetSecurityControlIds sets the SecurityControlIds field's value.

func (BatchGetSecurityControlsInput) String added in v1.44.209 

func (s BatchGetSecurityControlsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchGetSecurityControlsInput) Validate() error

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

type BatchGetSecurityControlsOutput added in v1.44.209 

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.44.209 

func (s BatchGetSecurityControlsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchGetSecurityControlsOutput) SetSecurityControls(v []*SecurityControl) *BatchGetSecurityControlsOutput

SetSecurityControls sets the SecurityControls field's value.

func (*BatchGetSecurityControlsOutput) SetUnprocessedIds added in v1.44.209 

func (s *BatchGetSecurityControlsOutput) SetUnprocessedIds(v []*UnprocessedSecurityControl) *BatchGetSecurityControlsOutput

SetUnprocessedIds sets the UnprocessedIds field's value.

func (BatchGetSecurityControlsOutput) String added in v1.44.209 

func (s BatchGetSecurityControlsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s BatchGetStandardsControlAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchGetStandardsControlAssociationsInput) SetStandardsControlAssociationIds(v []*StandardsControlAssociationId) *BatchGetStandardsControlAssociationsInput

SetStandardsControlAssociationIds sets the StandardsControlAssociationIds field's value.

func (BatchGetStandardsControlAssociationsInput) String added in v1.44.209 

func (s BatchGetStandardsControlAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchGetStandardsControlAssociationsInput) Validate() error

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

type BatchGetStandardsControlAssociationsOutput added in v1.44.209 

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.44.209 

func (s BatchGetStandardsControlAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchGetStandardsControlAssociationsOutput) SetStandardsControlAssociationDetails(v []*StandardsControlAssociationDetail) *BatchGetStandardsControlAssociationsOutput

SetStandardsControlAssociationDetails sets the StandardsControlAssociationDetails field's value.

func (*BatchGetStandardsControlAssociationsOutput) SetUnprocessedAssociations added in v1.44.209 

func (s *BatchGetStandardsControlAssociationsOutput) SetUnprocessedAssociations(v []*UnprocessedStandardsControlAssociation) *BatchGetStandardsControlAssociationsOutput

SetUnprocessedAssociations sets the UnprocessedAssociations field's value.

func (BatchGetStandardsControlAssociationsOutput) String added in v1.44.209 

func (s BatchGetStandardsControlAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *BatchImportFindingsInput) SetFindings(v []*AwsSecurityFinding) *BatchImportFindingsInput

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 

func (s *BatchImportFindingsOutput) SetFailedCount(v int64) *BatchImportFindingsOutput

SetFailedCount sets the FailedCount field's value.

func (*BatchImportFindingsOutput) SetFailedFindings 

func (s *BatchImportFindingsOutput) SetFailedFindings(v []*ImportFindingsError) *BatchImportFindingsOutput

SetFailedFindings sets the FailedFindings field's value.

func (*BatchImportFindingsOutput) SetSuccessCount 

func (s *BatchImportFindingsOutput) SetSuccessCount(v int64) *BatchImportFindingsOutput

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.44.282 

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.44.282 

func (s BatchUpdateAutomationRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchUpdateAutomationRulesInput) SetUpdateAutomationRulesRequestItems(v []*UpdateAutomationRulesRequestItem) *BatchUpdateAutomationRulesInput

SetUpdateAutomationRulesRequestItems sets the UpdateAutomationRulesRequestItems field's value.

func (BatchUpdateAutomationRulesInput) String added in v1.44.282 

func (s BatchUpdateAutomationRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchUpdateAutomationRulesInput) Validate() error

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

type BatchUpdateAutomationRulesOutput added in v1.44.282 

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.44.282 

func (s BatchUpdateAutomationRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *BatchUpdateAutomationRulesOutput) SetProcessedAutomationRules(v []*string) *BatchUpdateAutomationRulesOutput

SetProcessedAutomationRules sets the ProcessedAutomationRules field's value.

func (*BatchUpdateAutomationRulesOutput) SetUnprocessedAutomationRules added in v1.44.282 

func (s *BatchUpdateAutomationRulesOutput) SetUnprocessedAutomationRules(v []*UnprocessedAutomationRule) *BatchUpdateAutomationRulesOutput

SetUnprocessedAutomationRules sets the UnprocessedAutomationRules field's value.

func (BatchUpdateAutomationRulesOutput) String added in v1.44.282 

func (s BatchUpdateAutomationRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetConfidence(v int64) *BatchUpdateFindingsInput

SetConfidence sets the Confidence field's value.

func (*BatchUpdateFindingsInput) SetCriticality added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetCriticality(v int64) *BatchUpdateFindingsInput

SetCriticality sets the Criticality field's value.

func (*BatchUpdateFindingsInput) SetFindingIdentifiers added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetFindingIdentifiers(v []*AwsSecurityFindingIdentifier) *BatchUpdateFindingsInput

SetFindingIdentifiers sets the FindingIdentifiers field's value.

func (*BatchUpdateFindingsInput) SetNote added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetNote(v *NoteUpdate) *BatchUpdateFindingsInput

SetNote sets the Note field's value.

func (*BatchUpdateFindingsInput) SetRelatedFindings added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetRelatedFindings(v []*RelatedFinding) *BatchUpdateFindingsInput

SetRelatedFindings sets the RelatedFindings field's value.

func (*BatchUpdateFindingsInput) SetSeverity added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetSeverity(v *SeverityUpdate) *BatchUpdateFindingsInput

SetSeverity sets the Severity field's value.

func (*BatchUpdateFindingsInput) SetTypes added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetTypes(v []*string) *BatchUpdateFindingsInput

SetTypes sets the Types field's value.

func (*BatchUpdateFindingsInput) SetUserDefinedFields added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetUserDefinedFields(v map[string]*string) *BatchUpdateFindingsInput

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*BatchUpdateFindingsInput) SetVerificationState added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetVerificationState(v string) *BatchUpdateFindingsInput

SetVerificationState sets the VerificationState field's value.

func (*BatchUpdateFindingsInput) SetWorkflow added in v1.30.8 

func (s *BatchUpdateFindingsInput) SetWorkflow(v *WorkflowUpdate) *BatchUpdateFindingsInput

SetWorkflow sets the Workflow field's value.

func (BatchUpdateFindingsInput) String added in v1.30.8 

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 added in v1.30.8 

func (s *BatchUpdateFindingsInput) Validate() error

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

type BatchUpdateFindingsOutput added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

func (s *BatchUpdateFindingsOutput) SetProcessedFindings(v []*AwsSecurityFindingIdentifier) *BatchUpdateFindingsOutput

SetProcessedFindings sets the ProcessedFindings field's value.

func (*BatchUpdateFindingsOutput) SetUnprocessedFindings added in v1.30.8 

func (s *BatchUpdateFindingsOutput) SetUnprocessedFindings(v []*BatchUpdateFindingsUnprocessedFinding) *BatchUpdateFindingsOutput

SetUnprocessedFindings sets the UnprocessedFindings field's value.

func (BatchUpdateFindingsOutput) String added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

func (s BatchUpdateFindingsUnprocessedFinding) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.30.8 

func (s *BatchUpdateFindingsUnprocessedFinding) SetErrorCode(v string) *BatchUpdateFindingsUnprocessedFinding

SetErrorCode sets the ErrorCode field's value.

func (*BatchUpdateFindingsUnprocessedFinding) SetErrorMessage added in v1.30.8 

func (s *BatchUpdateFindingsUnprocessedFinding) SetErrorMessage(v string) *BatchUpdateFindingsUnprocessedFinding

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchUpdateFindingsUnprocessedFinding) SetFindingIdentifier added in v1.30.8 

func (s *BatchUpdateFindingsUnprocessedFinding) SetFindingIdentifier(v *AwsSecurityFindingIdentifier) *BatchUpdateFindingsUnprocessedFinding

SetFindingIdentifier sets the FindingIdentifier field's value.

func (BatchUpdateFindingsUnprocessedFinding) String added in v1.30.8 

func (s BatchUpdateFindingsUnprocessedFinding) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s BatchUpdateStandardsControlAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchUpdateStandardsControlAssociationsInput) SetStandardsControlAssociationUpdates(v []*StandardsControlAssociationUpdate) *BatchUpdateStandardsControlAssociationsInput

SetStandardsControlAssociationUpdates sets the StandardsControlAssociationUpdates field's value.

func (BatchUpdateStandardsControlAssociationsInput) String added in v1.44.209 

func (s BatchUpdateStandardsControlAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchUpdateStandardsControlAssociationsInput) Validate() error

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

type BatchUpdateStandardsControlAssociationsOutput added in v1.44.209 

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.44.209 

func (s BatchUpdateStandardsControlAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *BatchUpdateStandardsControlAssociationsOutput) SetUnprocessedAssociationUpdates(v []*UnprocessedStandardsControlAssociationUpdate) *BatchUpdateStandardsControlAssociationsOutput

SetUnprocessedAssociationUpdates sets the UnprocessedAssociationUpdates field's value.

func (BatchUpdateStandardsControlAssociationsOutput) String added in v1.44.209 

func (s BatchUpdateStandardsControlAssociationsOutput) String() string

String returns the string representation.

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

type BooleanConfigurationOptions added in v1.48.4 

type BooleanConfigurationOptions struct {

	// The Security Hub default value for a boolean parameter.
	DefaultValue *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter with a boolean. For a boolean parameter, the options are true and false.

func (BooleanConfigurationOptions) GoString added in v1.48.4 

func (s BooleanConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*BooleanConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *BooleanConfigurationOptions) SetDefaultValue(v bool) *BooleanConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (BooleanConfigurationOptions) String added in v1.48.4 

func (s BooleanConfigurationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.42 

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.42 

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.42 

func (s *BooleanFilter) SetValue(v bool) *BooleanFilter

SetValue sets the Value field's value.

func (BooleanFilter) String added in v1.42.42 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *Cell) SetCellReference(v string) *Cell

SetCellReference sets the CellReference field's value.

func (*Cell) SetColumn added in v1.38.0 

func (s *Cell) SetColumn(v int64) *Cell

SetColumn sets the Column field's value.

func (*Cell) SetColumnName added in v1.38.0 

func (s *Cell) SetColumnName(v string) *Cell

SetColumnName sets the ColumnName field's value.

func (*Cell) SetRow added in v1.38.0 

func (s *Cell) SetRow(v int64) *Cell

SetRow sets the Row field's value.

func (Cell) String added in v1.38.0 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *CidrBlockAssociation) SetAssociationId(v string) *CidrBlockAssociation

SetAssociationId sets the AssociationId field's value.

func (*CidrBlockAssociation) SetCidrBlock added in v1.33.0 

func (s *CidrBlockAssociation) SetCidrBlock(v string) *CidrBlockAssociation

SetCidrBlock sets the CidrBlock field's value.

func (*CidrBlockAssociation) SetCidrBlockState added in v1.33.0 

func (s *CidrBlockAssociation) SetCidrBlockState(v string) *CidrBlockAssociation

SetCidrBlockState sets the CidrBlockState field's value.

func (CidrBlockAssociation) String added in v1.33.0 

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 added in v1.36.30 

type City struct {

	// The name of the city.
	CityName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a city.

func (City) GoString added in v1.36.30 

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 added in v1.36.30 

func (s *City) SetCityName(v string) *City

SetCityName sets the CityName field's value.

func (City) String added in v1.36.30 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *ClassificationResult) SetAdditionalOccurrences(v bool) *ClassificationResult

SetAdditionalOccurrences sets the AdditionalOccurrences field's value.

func (*ClassificationResult) SetCustomDataIdentifiers added in v1.38.0 

func (s *ClassificationResult) SetCustomDataIdentifiers(v *CustomDataIdentifiersResult) *ClassificationResult

SetCustomDataIdentifiers sets the CustomDataIdentifiers field's value.

func (*ClassificationResult) SetMimeType added in v1.38.0 

func (s *ClassificationResult) SetMimeType(v string) *ClassificationResult

SetMimeType sets the MimeType field's value.

func (*ClassificationResult) SetSensitiveData added in v1.38.0 

func (s *ClassificationResult) SetSensitiveData(v []*SensitiveDataResult) *ClassificationResult

SetSensitiveData sets the SensitiveData field's value.

func (*ClassificationResult) SetSizeClassified added in v1.38.0 

func (s *ClassificationResult) SetSizeClassified(v int64) *ClassificationResult

SetSizeClassified sets the SizeClassified field's value.

func (*ClassificationResult) SetStatus added in v1.38.0 

func (s *ClassificationResult) SetStatus(v *ClassificationStatus) *ClassificationResult

SetStatus sets the Status field's value.

func (ClassificationResult) String added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *ClassificationStatus) SetCode(v string) *ClassificationStatus

SetCode sets the Code field's value.

func (*ClassificationStatus) SetReason added in v1.38.0 

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

SetReason sets the Reason field's value.

func (ClassificationStatus) String added in v1.38.0 

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 CloudWatchLogsLogGroupArnConfigDetails added in v1.45.23 

type CloudWatchLogsLogGroupArnConfigDetails struct {

	// The ARN of the CloudWatch Logs log group that Route 53 is publishing logs
	// to.
	CloudWatchLogsLogGroupArn *string `type:"string"`

	// The ID of the hosted zone that CloudWatch Logs is logging queries for.
	HostedZoneId *string `type:"string"`

	// The ID for a DNS query logging configuration.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

func (CloudWatchLogsLogGroupArnConfigDetails) GoString added in v1.45.23 

func (s CloudWatchLogsLogGroupArnConfigDetails) GoString() string

GoString returns the string representation.

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

func (*CloudWatchLogsLogGroupArnConfigDetails) SetCloudWatchLogsLogGroupArn added in v1.45.23 

func (s *CloudWatchLogsLogGroupArnConfigDetails) SetCloudWatchLogsLogGroupArn(v string) *CloudWatchLogsLogGroupArnConfigDetails

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*CloudWatchLogsLogGroupArnConfigDetails) SetHostedZoneId added in v1.45.23 

func (s *CloudWatchLogsLogGroupArnConfigDetails) SetHostedZoneId(v string) *CloudWatchLogsLogGroupArnConfigDetails

SetHostedZoneId sets the HostedZoneId field's value.

func (*CloudWatchLogsLogGroupArnConfigDetails) SetId added in v1.45.23 

func (s *CloudWatchLogsLogGroupArnConfigDetails) SetId(v string) *CloudWatchLogsLogGroupArnConfigDetails

SetId sets the Id field's value.

func (CloudWatchLogsLogGroupArnConfigDetails) String added in v1.45.23 

func (s CloudWatchLogsLogGroupArnConfigDetails) String() string

String returns the string representation.

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

type CodeVulnerabilitiesFilePath added in v1.44.327 

type CodeVulnerabilitiesFilePath struct {

	// The line number of the last line of code in which the vulnerability is located.
	EndLine *int64 `type:"integer"`

	// The name of the file in which the code vulnerability is located.
	FileName *string `type:"string"`

	// The file path to the code in which the vulnerability is located.
	FilePath *string `type:"string"`

	// The line number of the first line of code in which the vulnerability is located.
	StartLine *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides details about where a code vulnerability is located in your Lambda function.

func (CodeVulnerabilitiesFilePath) GoString added in v1.44.327 

func (s CodeVulnerabilitiesFilePath) GoString() string

GoString returns the string representation.

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

func (*CodeVulnerabilitiesFilePath) SetEndLine added in v1.44.327 

func (s *CodeVulnerabilitiesFilePath) SetEndLine(v int64) *CodeVulnerabilitiesFilePath

SetEndLine sets the EndLine field's value.

func (*CodeVulnerabilitiesFilePath) SetFileName added in v1.44.327 

func (s *CodeVulnerabilitiesFilePath) SetFileName(v string) *CodeVulnerabilitiesFilePath

SetFileName sets the FileName field's value.

func (*CodeVulnerabilitiesFilePath) SetFilePath added in v1.44.327 

func (s *CodeVulnerabilitiesFilePath) SetFilePath(v string) *CodeVulnerabilitiesFilePath

SetFilePath sets the FilePath field's value.

func (*CodeVulnerabilitiesFilePath) SetStartLine added in v1.44.327 

func (s *CodeVulnerabilitiesFilePath) SetStartLine(v int64) *CodeVulnerabilitiesFilePath

SetStartLine sets the StartLine field's value.

func (CodeVulnerabilitiesFilePath) String added in v1.44.327 

func (s CodeVulnerabilitiesFilePath) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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"`

	// An object that includes security control parameter names and values.
	SecurityControlParameters []*SecurityControlParameter `type:"list"`

	// 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.44.191 

func (s *Compliance) SetAssociatedStandards(v []*AssociatedStandard) *Compliance

SetAssociatedStandards sets the AssociatedStandards field's value.

func (*Compliance) SetRelatedRequirements added in v1.28.11 

func (s *Compliance) SetRelatedRequirements(v []*string) *Compliance

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*Compliance) SetSecurityControlId added in v1.44.191 

func (s *Compliance) SetSecurityControlId(v string) *Compliance

SetSecurityControlId sets the SecurityControlId field's value.

func (*Compliance) SetSecurityControlParameters added in v1.48.4 

func (s *Compliance) SetSecurityControlParameters(v []*SecurityControlParameter) *Compliance

SetSecurityControlParameters sets the SecurityControlParameters field's value.

func (*Compliance) SetStatus 

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

SetStatus sets the Status field's value.

func (*Compliance) SetStatusReasons added in v1.31.2 

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 added in v1.31.2 

func (s *Compliance) Validate() error

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

type ConfigurationOptions added in v1.48.4 

type ConfigurationOptions struct {

	// The options for customizing a security control parameter that is a boolean.
	// For a boolean parameter, the options are true and false.
	Boolean *BooleanConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is a double.
	Double *DoubleConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is an enum.
	Enum *EnumConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is a list of
	// enums.
	EnumList *EnumListConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is an integer.
	Integer *IntegerConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is a list of
	// integers.
	IntegerList *IntegerListConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is a list of
	// strings.
	StringList *StringListConfigurationOptions `type:"structure"`

	// The options for customizing a security control parameter that is a string
	// data type.
	String_ *StringConfigurationOptions `locationName:"String" type:"structure"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter.

func (ConfigurationOptions) GoString added in v1.48.4 

func (s ConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*ConfigurationOptions) SetBoolean added in v1.48.4 

func (s *ConfigurationOptions) SetBoolean(v *BooleanConfigurationOptions) *ConfigurationOptions

SetBoolean sets the Boolean field's value.

func (*ConfigurationOptions) SetDouble added in v1.48.4 

func (s *ConfigurationOptions) SetDouble(v *DoubleConfigurationOptions) *ConfigurationOptions

SetDouble sets the Double field's value.

func (*ConfigurationOptions) SetEnum added in v1.48.4 

func (s *ConfigurationOptions) SetEnum(v *EnumConfigurationOptions) *ConfigurationOptions

SetEnum sets the Enum field's value.

func (*ConfigurationOptions) SetEnumList added in v1.48.4 

func (s *ConfigurationOptions) SetEnumList(v *EnumListConfigurationOptions) *ConfigurationOptions

SetEnumList sets the EnumList field's value.

func (*ConfigurationOptions) SetInteger added in v1.48.4 

func (s *ConfigurationOptions) SetInteger(v *IntegerConfigurationOptions) *ConfigurationOptions

SetInteger sets the Integer field's value.

func (*ConfigurationOptions) SetIntegerList added in v1.48.4 

func (s *ConfigurationOptions) SetIntegerList(v *IntegerListConfigurationOptions) *ConfigurationOptions

SetIntegerList sets the IntegerList field's value.

func (*ConfigurationOptions) SetStringList added in v1.48.4 

func (s *ConfigurationOptions) SetStringList(v *StringListConfigurationOptions) *ConfigurationOptions

SetStringList sets the StringList field's value.

func (*ConfigurationOptions) SetString_ added in v1.48.4 

func (s *ConfigurationOptions) SetString_(v *StringConfigurationOptions) *ConfigurationOptions

SetString_ sets the String_ field's value.

func (ConfigurationOptions) String added in v1.48.4 

func (s ConfigurationOptions) String() string

String returns the string representation.

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

type ConfigurationPolicyAssociation added in v1.48.5 

type ConfigurationPolicyAssociation struct {

	// The target account, organizational unit, or the root.
	Target *Target `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about the association between an Security Hub configuration and a target account, organizational unit, or the root. An association can exist between a target and a configuration policy, or between a target and self-managed behavior.

func (ConfigurationPolicyAssociation) GoString added in v1.48.5 

func (s ConfigurationPolicyAssociation) GoString() string

GoString returns the string representation.

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

func (*ConfigurationPolicyAssociation) SetTarget added in v1.48.5 

func (s *ConfigurationPolicyAssociation) SetTarget(v *Target) *ConfigurationPolicyAssociation

SetTarget sets the Target field's value.

func (ConfigurationPolicyAssociation) String added in v1.48.5 

func (s ConfigurationPolicyAssociation) String() string

String returns the string representation.

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

type ConfigurationPolicyAssociationSummary added in v1.48.5 

type ConfigurationPolicyAssociationSummary struct {

	// The current status of the association between the specified target and the
	// configuration.
	AssociationStatus *string `type:"string" enum:"ConfigurationPolicyAssociationStatus"`

	// The explanation for a FAILED value for AssociationStatus.
	AssociationStatusMessage *string `type:"string"`

	// Indicates whether the association between the specified target and the configuration
	// was directly applied by the Security Hub delegated administrator or inherited
	// from a parent.
	AssociationType *string `type:"string" enum:"AssociationType"`

	// The universally unique identifier (UUID) of the configuration policy.
	ConfigurationPolicyId *string `type:"string"`

	// The identifier of the target account, organizational unit, or the root.
	TargetId *string `type:"string"`

	// Specifies whether the target is an Amazon Web Services account, organizational
	// unit, or the root.
	TargetType *string `type:"string" enum:"TargetType"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// association was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

An object that contains the details of a configuration policy association that’s returned in a ListConfigurationPolicyAssociations request.

func (ConfigurationPolicyAssociationSummary) GoString added in v1.48.5 

func (s ConfigurationPolicyAssociationSummary) GoString() string

GoString returns the string representation.

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

func (*ConfigurationPolicyAssociationSummary) SetAssociationStatus added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetAssociationStatus(v string) *ConfigurationPolicyAssociationSummary

SetAssociationStatus sets the AssociationStatus field's value.

func (*ConfigurationPolicyAssociationSummary) SetAssociationStatusMessage added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetAssociationStatusMessage(v string) *ConfigurationPolicyAssociationSummary

SetAssociationStatusMessage sets the AssociationStatusMessage field's value.

func (*ConfigurationPolicyAssociationSummary) SetAssociationType added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetAssociationType(v string) *ConfigurationPolicyAssociationSummary

SetAssociationType sets the AssociationType field's value.

func (*ConfigurationPolicyAssociationSummary) SetConfigurationPolicyId added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetConfigurationPolicyId(v string) *ConfigurationPolicyAssociationSummary

SetConfigurationPolicyId sets the ConfigurationPolicyId field's value.

func (*ConfigurationPolicyAssociationSummary) SetTargetId added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetTargetId(v string) *ConfigurationPolicyAssociationSummary

SetTargetId sets the TargetId field's value.

func (*ConfigurationPolicyAssociationSummary) SetTargetType added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetTargetType(v string) *ConfigurationPolicyAssociationSummary

SetTargetType sets the TargetType field's value.

func (*ConfigurationPolicyAssociationSummary) SetUpdatedAt added in v1.48.5 

func (s *ConfigurationPolicyAssociationSummary) SetUpdatedAt(v time.Time) *ConfigurationPolicyAssociationSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (ConfigurationPolicyAssociationSummary) String added in v1.48.5 

func (s ConfigurationPolicyAssociationSummary) String() string

String returns the string representation.

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

type ConfigurationPolicySummary added in v1.48.5 

type ConfigurationPolicySummary struct {

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

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

	// The universally unique identifier (UUID) of the configuration policy.
	Id *string `type:"string"`

	// The name of the configuration policy. Alphanumeric characters and the following
	// ASCII characters are permitted: -, ., !, *, /.
	Name *string `type:"string"`

	// Indicates whether the service that the configuration policy applies to is
	// enabled in the policy.
	ServiceEnabled *bool `type:"boolean"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

An object that contains the details of an Security Hub configuration policy that’s returned in a ListConfigurationPolicies request.

func (ConfigurationPolicySummary) GoString added in v1.48.5 

func (s ConfigurationPolicySummary) GoString() string

GoString returns the string representation.

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

func (*ConfigurationPolicySummary) SetArn added in v1.48.5 

func (s *ConfigurationPolicySummary) SetArn(v string) *ConfigurationPolicySummary

SetArn sets the Arn field's value.

func (*ConfigurationPolicySummary) SetDescription added in v1.48.5 

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

SetDescription sets the Description field's value.

func (*ConfigurationPolicySummary) SetId added in v1.48.5 

func (s *ConfigurationPolicySummary) SetId(v string) *ConfigurationPolicySummary

SetId sets the Id field's value.

func (*ConfigurationPolicySummary) SetName added in v1.48.5 

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

SetName sets the Name field's value.

func (*ConfigurationPolicySummary) SetServiceEnabled added in v1.48.5 

func (s *ConfigurationPolicySummary) SetServiceEnabled(v bool) *ConfigurationPolicySummary

SetServiceEnabled sets the ServiceEnabled field's value.

func (*ConfigurationPolicySummary) SetUpdatedAt added in v1.48.5 

func (s *ConfigurationPolicySummary) SetUpdatedAt(v time.Time) *ConfigurationPolicySummary

SetUpdatedAt sets the UpdatedAt field's value.

func (ConfigurationPolicySummary) String added in v1.48.5 

func (s ConfigurationPolicySummary) String() string

String returns the string representation.

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

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.44.36 

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.44.36 

func (s *ContainerDetails) SetPrivileged(v bool) *ContainerDetails

SetPrivileged sets the Privileged field's value.

func (*ContainerDetails) SetVolumeMounts added in v1.44.36 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *Country) SetCountryCode(v string) *Country

SetCountryCode sets the CountryCode field's value.

func (*Country) SetCountryName added in v1.36.30 

func (s *Country) SetCountryName(v string) *Country

SetCountryName sets the CountryName field's value.

func (Country) String added in v1.36.30 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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

SetDescription sets the Description field's value.

func (*CreateActionTargetInput) SetId added in v1.20.7 

func (s *CreateActionTargetInput) SetId(v string) *CreateActionTargetInput

SetId sets the Id field's value.

func (*CreateActionTargetInput) SetName added in v1.20.7 

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

SetName sets the Name field's value.

func (CreateActionTargetInput) String added in v1.20.7 

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 added in v1.20.7 

func (s *CreateActionTargetInput) Validate() error

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

type CreateActionTargetOutput added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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

SetActionTargetArn sets the ActionTargetArn field's value.

func (CreateActionTargetOutput) String added in v1.20.7 

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.44.282 

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 associated with an automation rule.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAutomationRuleInput) GoString added in v1.44.282 

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.44.282 

func (s *CreateAutomationRuleInput) SetActions(v []*AutomationRulesAction) *CreateAutomationRuleInput

SetActions sets the Actions field's value.

func (*CreateAutomationRuleInput) SetCriteria added in v1.44.282 

func (s *CreateAutomationRuleInput) SetCriteria(v *AutomationRulesFindingFilters) *CreateAutomationRuleInput

SetCriteria sets the Criteria field's value.

func (*CreateAutomationRuleInput) SetDescription added in v1.44.282 

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

SetDescription sets the Description field's value.

func (*CreateAutomationRuleInput) SetIsTerminal added in v1.44.282 

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

SetIsTerminal sets the IsTerminal field's value.

func (*CreateAutomationRuleInput) SetRuleName added in v1.44.282 

func (s *CreateAutomationRuleInput) SetRuleName(v string) *CreateAutomationRuleInput

SetRuleName sets the RuleName field's value.

func (*CreateAutomationRuleInput) SetRuleOrder added in v1.44.282 

func (s *CreateAutomationRuleInput) SetRuleOrder(v int64) *CreateAutomationRuleInput

SetRuleOrder sets the RuleOrder field's value.

func (*CreateAutomationRuleInput) SetRuleStatus added in v1.44.282 

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

SetRuleStatus sets the RuleStatus field's value.

func (*CreateAutomationRuleInput) SetTags added in v1.44.282 

func (s *CreateAutomationRuleInput) SetTags(v map[string]*string) *CreateAutomationRuleInput

SetTags sets the Tags field's value.

func (CreateAutomationRuleInput) String added in v1.44.282 

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.44.282 

func (s *CreateAutomationRuleInput) Validate() error

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

type CreateAutomationRuleOutput added in v1.44.282 

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.44.282 

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.44.282 

func (s *CreateAutomationRuleOutput) SetRuleArn(v string) *CreateAutomationRuleOutput

SetRuleArn sets the RuleArn field's value.

func (CreateAutomationRuleOutput) String added in v1.44.282 

func (s CreateAutomationRuleOutput) String() string

String returns the string representation.

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

type CreateConfigurationPolicyInput added in v1.48.5 

type CreateConfigurationPolicyInput struct {

	// An object that defines how Security Hub is configured. It includes whether
	// Security Hub is enabled or disabled, a list of enabled security standards,
	// a list of enabled or disabled security controls, and a list of custom parameter
	// values for specified controls. If you provide a list of security controls
	// that are enabled in the configuration policy, Security Hub disables all other
	// controls (including newly released controls). If you provide a list of security
	// controls that are disabled in the configuration policy, Security Hub enables
	// all other controls (including newly released controls).
	//
	// ConfigurationPolicy is a required field
	ConfigurationPolicy *Policy `type:"structure" required:"true"`

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

	// The name of the configuration policy. Alphanumeric characters and the following
	// ASCII characters are permitted: -, ., !, *, /.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// User-defined tags associated with a configuration policy. For more information,
	// see Tagging Security Hub resources (https://docs.aws.amazon.com/securityhub/latest/userguide/tagging-resources.html)
	// in the Security Hub user guide.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateConfigurationPolicyInput) GoString added in v1.48.5 

func (s CreateConfigurationPolicyInput) GoString() string

GoString returns the string representation.

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

func (*CreateConfigurationPolicyInput) SetConfigurationPolicy added in v1.48.5 

func (s *CreateConfigurationPolicyInput) SetConfigurationPolicy(v *Policy) *CreateConfigurationPolicyInput

SetConfigurationPolicy sets the ConfigurationPolicy field's value.

func (*CreateConfigurationPolicyInput) SetDescription added in v1.48.5 

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

SetDescription sets the Description field's value.

func (*CreateConfigurationPolicyInput) SetName added in v1.48.5 

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

SetName sets the Name field's value.

func (*CreateConfigurationPolicyInput) SetTags added in v1.48.5 

func (s *CreateConfigurationPolicyInput) SetTags(v map[string]*string) *CreateConfigurationPolicyInput

SetTags sets the Tags field's value.

func (CreateConfigurationPolicyInput) String added in v1.48.5 

func (s CreateConfigurationPolicyInput) String() string

String returns the string representation.

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

func (*CreateConfigurationPolicyInput) Validate added in v1.48.5 

func (s *CreateConfigurationPolicyInput) Validate() error

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

type CreateConfigurationPolicyOutput added in v1.48.5 

type CreateConfigurationPolicyOutput struct {

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

	// An object that defines how Security Hub is configured. It includes whether
	// Security Hub is enabled or disabled, a list of enabled security standards,
	// a list of enabled or disabled security controls, and a list of custom parameter
	// values for specified controls. If the request included a list of security
	// controls that are enabled in the configuration policy, Security Hub disables
	// all other controls (including newly released controls). If the request included
	// a list of security controls that are disabled in the configuration policy,
	// Security Hub enables all other controls (including newly released controls).
	ConfigurationPolicy *Policy `type:"structure"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

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

	// The universally unique identifier (UUID) of the configuration policy.
	Id *string `type:"string"`

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

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (CreateConfigurationPolicyOutput) GoString added in v1.48.5 

func (s CreateConfigurationPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*CreateConfigurationPolicyOutput) SetArn added in v1.48.5 

func (s *CreateConfigurationPolicyOutput) SetArn(v string) *CreateConfigurationPolicyOutput

SetArn sets the Arn field's value.

func (*CreateConfigurationPolicyOutput) SetConfigurationPolicy added in v1.48.5 

func (s *CreateConfigurationPolicyOutput) SetConfigurationPolicy(v *Policy) *CreateConfigurationPolicyOutput

SetConfigurationPolicy sets the ConfigurationPolicy field's value.

func (*CreateConfigurationPolicyOutput) SetCreatedAt added in v1.48.5 

func (s *CreateConfigurationPolicyOutput) SetCreatedAt(v time.Time) *CreateConfigurationPolicyOutput

SetCreatedAt sets the CreatedAt field's value.

func (*CreateConfigurationPolicyOutput) SetDescription added in v1.48.5 

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

SetDescription sets the Description field's value.

func (*CreateConfigurationPolicyOutput) SetId added in v1.48.5 

func (s *CreateConfigurationPolicyOutput) SetId(v string) *CreateConfigurationPolicyOutput

SetId sets the Id field's value.

func (*CreateConfigurationPolicyOutput) SetName added in v1.48.5 

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

SetName sets the Name field's value.

func (*CreateConfigurationPolicyOutput) SetUpdatedAt added in v1.48.5 

func (s *CreateConfigurationPolicyOutput) SetUpdatedAt(v time.Time) *CreateConfigurationPolicyOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (CreateConfigurationPolicyOutput) String added in v1.48.5 

func (s CreateConfigurationPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *CreateFindingAggregatorInput) SetRegionLinkingMode(v string) *CreateFindingAggregatorInput

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*CreateFindingAggregatorInput) SetRegions added in v1.41.7 

func (s *CreateFindingAggregatorInput) SetRegions(v []*string) *CreateFindingAggregatorInput

SetRegions sets the Regions field's value.

func (CreateFindingAggregatorInput) String added in v1.41.7 

func (s CreateFindingAggregatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s *CreateFindingAggregatorInput) Validate() error

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

type CreateFindingAggregatorOutput added in v1.41.7 

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 added in v1.41.7 

func (s CreateFindingAggregatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s *CreateFindingAggregatorOutput) SetFindingAggregationRegion(v string) *CreateFindingAggregatorOutput

SetFindingAggregationRegion sets the FindingAggregationRegion field's value.

func (*CreateFindingAggregatorOutput) SetFindingAggregatorArn added in v1.41.7 

func (s *CreateFindingAggregatorOutput) SetFindingAggregatorArn(v string) *CreateFindingAggregatorOutput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*CreateFindingAggregatorOutput) SetRegionLinkingMode added in v1.41.7 

func (s *CreateFindingAggregatorOutput) SetRegionLinkingMode(v string) *CreateFindingAggregatorOutput

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*CreateFindingAggregatorOutput) SetRegions added in v1.41.7 

func (s *CreateFindingAggregatorOutput) SetRegions(v []*string) *CreateFindingAggregatorOutput

SetRegions sets the Regions field's value.

func (CreateFindingAggregatorOutput) String added in v1.41.7 

func (s CreateFindingAggregatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *CreateInsightInput) SetFilters(v *AwsSecurityFindingFilters) *CreateInsightInput

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 

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

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 added in v1.35.34 

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 added in v1.38.0 

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 added in v1.38.0 

func (s CustomDataIdentifiersDetections) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.0 

func (s *CustomDataIdentifiersDetections) SetArn(v string) *CustomDataIdentifiersDetections

SetArn sets the Arn field's value.

func (*CustomDataIdentifiersDetections) SetCount added in v1.38.0 

func (s *CustomDataIdentifiersDetections) SetCount(v int64) *CustomDataIdentifiersDetections

SetCount sets the Count field's value.

func (*CustomDataIdentifiersDetections) SetName added in v1.38.0 

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

SetName sets the Name field's value.

func (*CustomDataIdentifiersDetections) SetOccurrences added in v1.38.0 

func (s *CustomDataIdentifiersDetections) SetOccurrences(v *Occurrences) *CustomDataIdentifiersDetections

SetOccurrences sets the Occurrences field's value.

func (CustomDataIdentifiersDetections) String added in v1.38.0 

func (s CustomDataIdentifiersDetections) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *CustomDataIdentifiersResult) SetDetections(v []*CustomDataIdentifiersDetections) *CustomDataIdentifiersResult

SetDetections sets the Detections field's value.

func (*CustomDataIdentifiersResult) SetTotalCount added in v1.38.0 

func (s *CustomDataIdentifiersResult) SetTotalCount(v int64) *CustomDataIdentifiersResult

SetTotalCount sets the TotalCount field's value.

func (CustomDataIdentifiersResult) String added in v1.38.0 

func (s CustomDataIdentifiersResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.40.36 

func (s *Cvss) SetAdjustments(v []*Adjustment) *Cvss

SetAdjustments sets the Adjustments field's value.

func (*Cvss) SetBaseScore added in v1.33.0 

func (s *Cvss) SetBaseScore(v float64) *Cvss

SetBaseScore sets the BaseScore field's value.

func (*Cvss) SetBaseVector added in v1.33.0 

func (s *Cvss) SetBaseVector(v string) *Cvss

SetBaseVector sets the BaseVector field's value.

func (*Cvss) SetSource added in v1.40.36 

func (s *Cvss) SetSource(v string) *Cvss

SetSource sets the Source field's value.

func (*Cvss) SetVersion added in v1.33.0 

func (s *Cvss) SetVersion(v string) *Cvss

SetVersion sets the Version field's value.

func (Cvss) String added in v1.33.0 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *DataClassificationDetails) SetDetailedResultsLocation(v string) *DataClassificationDetails

SetDetailedResultsLocation sets the DetailedResultsLocation field's value.

func (*DataClassificationDetails) SetResult added in v1.38.0 

func (s *DataClassificationDetails) SetResult(v *ClassificationResult) *DataClassificationDetails

SetResult sets the Result field's value.

func (DataClassificationDetails) String added in v1.38.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	End *string `type:"string"`

	// A timestamp that provides the start date for the date filter.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.23.9 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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

SetActionTargetArn sets the ActionTargetArn field's value.

func (DeleteActionTargetInput) String added in v1.20.7 

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 added in v1.20.7 

func (s *DeleteActionTargetInput) Validate() error

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

type DeleteActionTargetOutput added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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

SetActionTargetArn sets the ActionTargetArn field's value.

func (DeleteActionTargetOutput) String added in v1.20.7 

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 DeleteConfigurationPolicyInput added in v1.48.5 

type DeleteConfigurationPolicyInput struct {

	// The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
	// the configuration policy.
	//
	// Identifier is a required field
	Identifier *string `location:"uri" locationName:"Identifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConfigurationPolicyInput) GoString added in v1.48.5 

func (s DeleteConfigurationPolicyInput) GoString() string

GoString returns the string representation.

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

func (*DeleteConfigurationPolicyInput) SetIdentifier added in v1.48.5 

func (s *DeleteConfigurationPolicyInput) SetIdentifier(v string) *DeleteConfigurationPolicyInput

SetIdentifier sets the Identifier field's value.

func (DeleteConfigurationPolicyInput) String added in v1.48.5 

func (s DeleteConfigurationPolicyInput) String() string

String returns the string representation.

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

func (*DeleteConfigurationPolicyInput) Validate added in v1.48.5 

func (s *DeleteConfigurationPolicyInput) Validate() error

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

type DeleteConfigurationPolicyOutput added in v1.48.5 

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

func (DeleteConfigurationPolicyOutput) GoString added in v1.48.5 

func (s DeleteConfigurationPolicyOutput) GoString() string

GoString returns the string representation.

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

func (DeleteConfigurationPolicyOutput) String added in v1.48.5 

func (s DeleteConfigurationPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *DeleteFindingAggregatorInput) SetFindingAggregatorArn(v string) *DeleteFindingAggregatorInput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (DeleteFindingAggregatorInput) String added in v1.41.7 

func (s DeleteFindingAggregatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s *DeleteFindingAggregatorInput) Validate() error

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

type DeleteFindingAggregatorOutput added in v1.41.7 

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

func (DeleteFindingAggregatorOutput) GoString added in v1.41.7 

func (s DeleteFindingAggregatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s DeleteFindingAggregatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.23.9 

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 added in v1.35.34 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *DescribeActionTargetsInput) SetActionTargetArns(v []*string) *DescribeActionTargetsInput

SetActionTargetArns sets the ActionTargetArns field's value.

func (*DescribeActionTargetsInput) SetMaxResults added in v1.20.7 

func (s *DescribeActionTargetsInput) SetMaxResults(v int64) *DescribeActionTargetsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeActionTargetsInput) SetNextToken added in v1.20.7 

func (s *DescribeActionTargetsInput) SetNextToken(v string) *DescribeActionTargetsInput

SetNextToken sets the NextToken field's value.

func (DescribeActionTargetsInput) String added in v1.20.7 

func (s DescribeActionTargetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.20.7 

func (s *DescribeActionTargetsInput) Validate() error

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

type DescribeActionTargetsOutput added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *DescribeActionTargetsOutput) SetActionTargets(v []*ActionTarget) *DescribeActionTargetsOutput

SetActionTargets sets the ActionTargets field's value.

func (*DescribeActionTargetsOutput) SetNextToken added in v1.20.7 

func (s *DescribeActionTargetsOutput) SetNextToken(v string) *DescribeActionTargetsOutput

SetNextToken sets the NextToken field's value.

func (DescribeActionTargetsOutput) String added in v1.20.7 

func (s DescribeActionTargetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *DescribeHubInput) SetHubArn(v string) *DescribeHubInput

SetHubArn sets the HubArn field's value.

func (DescribeHubInput) String added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.33.14 

func (s *DescribeHubOutput) SetAutoEnableControls(v bool) *DescribeHubOutput

SetAutoEnableControls sets the AutoEnableControls field's value.

func (*DescribeHubOutput) SetControlFindingGenerator added in v1.44.209 

func (s *DescribeHubOutput) SetControlFindingGenerator(v string) *DescribeHubOutput

SetControlFindingGenerator sets the ControlFindingGenerator field's value.

func (*DescribeHubOutput) SetHubArn added in v1.20.7 

func (s *DescribeHubOutput) SetHubArn(v string) *DescribeHubOutput

SetHubArn sets the HubArn field's value.

func (*DescribeHubOutput) SetSubscribedAt added in v1.20.7 

func (s *DescribeHubOutput) SetSubscribedAt(v string) *DescribeHubOutput

SetSubscribedAt sets the SubscribedAt field's value.

func (DescribeHubOutput) String added in v1.20.7 

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 added in v1.35.34 

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

func (DescribeOrganizationConfigurationInput) GoString added in v1.35.34 

func (s DescribeOrganizationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s DescribeOrganizationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

type DescribeOrganizationConfigurationOutput struct {

	// Whether to automatically enable Security Hub in new member accounts when
	// they join the organization.
	//
	// If set to true, then Security Hub is automatically enabled in new accounts.
	// If set to false, then Security Hub isn't enabled in new accounts automatically.
	// The default value is false.
	//
	// If the ConfigurationType of your organization is set to CENTRAL, then this
	// field is set to false and can't be changed in the home Region and linked
	// Regions. However, in that case, the delegated administrator can create a
	// configuration policy in which Security Hub is enabled and associate the policy
	// with new organization accounts.
	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)
	// in new member accounts when they join the organization.
	//
	// 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. The default value
	// of this parameter is equal to DEFAULT.
	//
	// If the ConfigurationType of your organization is set to CENTRAL, then this
	// field is set to NONE and can't be changed in the home Region and linked Regions.
	// However, in that case, the delegated administrator can create a configuration
	// policy in which specific security standards are enabled and associate the
	// policy with new organization 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"`

	// Provides information about the way an organization is configured in Security
	// Hub.
	OrganizationConfiguration *OrganizationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeOrganizationConfigurationOutput) GoString added in v1.35.34 

func (s DescribeOrganizationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *DescribeOrganizationConfigurationOutput) SetAutoEnable(v bool) *DescribeOrganizationConfigurationOutput

SetAutoEnable sets the AutoEnable field's value.

func (*DescribeOrganizationConfigurationOutput) SetAutoEnableStandards added in v1.44.0 

func (s *DescribeOrganizationConfigurationOutput) SetAutoEnableStandards(v string) *DescribeOrganizationConfigurationOutput

SetAutoEnableStandards sets the AutoEnableStandards field's value.

func (*DescribeOrganizationConfigurationOutput) SetMemberAccountLimitReached added in v1.35.34 

func (s *DescribeOrganizationConfigurationOutput) SetMemberAccountLimitReached(v bool) *DescribeOrganizationConfigurationOutput

SetMemberAccountLimitReached sets the MemberAccountLimitReached field's value.

func (*DescribeOrganizationConfigurationOutput) SetOrganizationConfiguration added in v1.48.5 

func (s *DescribeOrganizationConfigurationOutput) SetOrganizationConfiguration(v *OrganizationConfiguration) *DescribeOrganizationConfigurationOutput

SetOrganizationConfiguration sets the OrganizationConfiguration field's value.

func (DescribeOrganizationConfigurationOutput) String added in v1.35.34 

func (s DescribeOrganizationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.19.40 

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 added in v1.19.40 

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 added in v1.19.40 

func (s *DescribeProductsInput) SetMaxResults(v int64) *DescribeProductsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeProductsInput) SetNextToken added in v1.19.40 

func (s *DescribeProductsInput) SetNextToken(v string) *DescribeProductsInput

SetNextToken sets the NextToken field's value.

func (*DescribeProductsInput) SetProductArn added in v1.37.3 

func (s *DescribeProductsInput) SetProductArn(v string) *DescribeProductsInput

SetProductArn sets the ProductArn field's value.

func (DescribeProductsInput) String added in v1.19.40 

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 added in v1.19.40 

func (s *DescribeProductsInput) Validate() error

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

type DescribeProductsOutput added in v1.19.40 

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 added in v1.19.40 

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 added in v1.19.40 

func (s *DescribeProductsOutput) SetNextToken(v string) *DescribeProductsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeProductsOutput) SetProducts added in v1.19.40 

func (s *DescribeProductsOutput) SetProducts(v []*Product) *DescribeProductsOutput

SetProducts sets the Products field's value.

func (DescribeProductsOutput) String added in v1.19.40 

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 added in v1.28.3 

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 added in v1.28.3 

func (s DescribeStandardsControlsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.3 

func (s *DescribeStandardsControlsInput) SetMaxResults(v int64) *DescribeStandardsControlsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeStandardsControlsInput) SetNextToken added in v1.28.3 

func (s *DescribeStandardsControlsInput) SetNextToken(v string) *DescribeStandardsControlsInput

SetNextToken sets the NextToken field's value.

func (*DescribeStandardsControlsInput) SetStandardsSubscriptionArn added in v1.28.3 

func (s *DescribeStandardsControlsInput) SetStandardsSubscriptionArn(v string) *DescribeStandardsControlsInput

SetStandardsSubscriptionArn sets the StandardsSubscriptionArn field's value.

func (DescribeStandardsControlsInput) String added in v1.28.3 

func (s DescribeStandardsControlsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.3 

func (s *DescribeStandardsControlsInput) Validate() error

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

type DescribeStandardsControlsOutput added in v1.28.3 

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 added in v1.28.3 

func (s DescribeStandardsControlsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.3 

func (s *DescribeStandardsControlsOutput) SetControls(v []*StandardsControl) *DescribeStandardsControlsOutput

SetControls sets the Controls field's value.

func (*DescribeStandardsControlsOutput) SetNextToken added in v1.28.3 

func (s *DescribeStandardsControlsOutput) SetNextToken(v string) *DescribeStandardsControlsOutput

SetNextToken sets the NextToken field's value.

func (DescribeStandardsControlsOutput) String added in v1.28.3 

func (s DescribeStandardsControlsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

func (s *DescribeStandardsInput) SetMaxResults(v int64) *DescribeStandardsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeStandardsInput) SetNextToken added in v1.29.3 

func (s *DescribeStandardsInput) SetNextToken(v string) *DescribeStandardsInput

SetNextToken sets the NextToken field's value.

func (DescribeStandardsInput) String added in v1.29.3 

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 added in v1.29.3 

func (s *DescribeStandardsInput) Validate() error

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

type DescribeStandardsOutput added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

func (s *DescribeStandardsOutput) SetNextToken(v string) *DescribeStandardsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeStandardsOutput) SetStandards added in v1.29.3 

func (s *DescribeStandardsOutput) SetStandards(v []*Standard) *DescribeStandardsOutput

SetStandards sets the Standards field's value.

func (DescribeStandardsOutput) String added in v1.29.3 

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 

func (s DisableImportFindingsForProductInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *DisableImportFindingsForProductInput) SetProductSubscriptionArn(v string) *DisableImportFindingsForProductInput

SetProductSubscriptionArn sets the ProductSubscriptionArn field's value.

func (DisableImportFindingsForProductInput) String 

func (s DisableImportFindingsForProductInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *DisableImportFindingsForProductInput) Validate() error

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 

func (s DisableImportFindingsForProductOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s DisableImportFindingsForProductOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

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 added in v1.35.34 

func (s DisableOrganizationAdminAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *DisableOrganizationAdminAccountInput) SetAdminAccountId(v string) *DisableOrganizationAdminAccountInput

SetAdminAccountId sets the AdminAccountId field's value.

func (DisableOrganizationAdminAccountInput) String added in v1.35.34 

func (s DisableOrganizationAdminAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *DisableOrganizationAdminAccountInput) Validate() error

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

type DisableOrganizationAdminAccountOutput added in v1.35.34 

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

func (DisableOrganizationAdminAccountOutput) GoString added in v1.35.34 

func (s DisableOrganizationAdminAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s DisableOrganizationAdminAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

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

func (DisassociateFromAdministratorAccountInput) GoString added in v1.38.24 

func (s DisassociateFromAdministratorAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

func (s DisassociateFromAdministratorAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

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

func (DisassociateFromAdministratorAccountOutput) GoString added in v1.38.24 

func (s DisassociateFromAdministratorAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

func (s DisassociateFromAdministratorAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s DisassociateFromMasterAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s DisassociateFromMasterAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s DisassociateFromMasterAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s DisassociateFromMasterAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *DisassociateMembersInput) SetAccountIds(v []*string) *DisassociateMembersInput

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 added in v1.35.34 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *DnsRequestAction) SetBlocked(v bool) *DnsRequestAction

SetBlocked sets the Blocked field's value.

func (*DnsRequestAction) SetDomain added in v1.36.30 

func (s *DnsRequestAction) SetDomain(v string) *DnsRequestAction

SetDomain sets the Domain field's value.

func (*DnsRequestAction) SetProtocol added in v1.36.30 

func (s *DnsRequestAction) SetProtocol(v string) *DnsRequestAction

SetProtocol sets the Protocol field's value.

func (DnsRequestAction) String added in v1.36.30 

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 DoubleConfigurationOptions added in v1.48.4 

type DoubleConfigurationOptions struct {

	// The Security Hub default value for a control parameter that is a double.
	DefaultValue *float64 `type:"double"`

	// The maximum valid value for a control parameter that is a double.
	Max *float64 `type:"double"`

	// The minimum valid value for a control parameter that is a double.
	Min *float64 `type:"double"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is a double.

func (DoubleConfigurationOptions) GoString added in v1.48.4 

func (s DoubleConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*DoubleConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *DoubleConfigurationOptions) SetDefaultValue(v float64) *DoubleConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (*DoubleConfigurationOptions) SetMax added in v1.48.4 

func (s *DoubleConfigurationOptions) SetMax(v float64) *DoubleConfigurationOptions

SetMax sets the Max field's value.

func (*DoubleConfigurationOptions) SetMin added in v1.48.4 

func (s *DoubleConfigurationOptions) SetMin(v float64) *DoubleConfigurationOptions

SetMin sets the Min field's value.

func (DoubleConfigurationOptions) String added in v1.48.4 

func (s DoubleConfigurationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s EnableImportFindingsForProductInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *EnableImportFindingsForProductInput) SetProductArn(v string) *EnableImportFindingsForProductInput

SetProductArn sets the ProductArn field's value.

func (EnableImportFindingsForProductInput) String 

func (s EnableImportFindingsForProductInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *EnableImportFindingsForProductInput) Validate() error

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 

func (s EnableImportFindingsForProductOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *EnableImportFindingsForProductOutput) SetProductSubscriptionArn(v string) *EnableImportFindingsForProductOutput

SetProductSubscriptionArn sets the ProductSubscriptionArn field's value.

func (EnableImportFindingsForProductOutput) String 

func (s EnableImportFindingsForProductOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

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 added in v1.35.34 

func (s EnableOrganizationAdminAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *EnableOrganizationAdminAccountInput) SetAdminAccountId(v string) *EnableOrganizationAdminAccountInput

SetAdminAccountId sets the AdminAccountId field's value.

func (EnableOrganizationAdminAccountInput) String added in v1.35.34 

func (s EnableOrganizationAdminAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *EnableOrganizationAdminAccountInput) Validate() error

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

type EnableOrganizationAdminAccountOutput added in v1.35.34 

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

func (EnableOrganizationAdminAccountOutput) GoString added in v1.35.34 

func (s EnableOrganizationAdminAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s EnableOrganizationAdminAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *EnableSecurityHubInput) SetControlFindingGenerator(v string) *EnableSecurityHubInput

SetControlFindingGenerator sets the ControlFindingGenerator field's value.

func (*EnableSecurityHubInput) SetEnableDefaultStandards added in v1.29.33 

func (s *EnableSecurityHubInput) SetEnableDefaultStandards(v bool) *EnableSecurityHubInput

SetEnableDefaultStandards sets the EnableDefaultStandards field's value.

func (*EnableSecurityHubInput) SetTags added in v1.20.7 

func (s *EnableSecurityHubInput) SetTags(v map[string]*string) *EnableSecurityHubInput

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 added in v1.20.7 

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 EnumConfigurationOptions added in v1.48.4 

type EnumConfigurationOptions struct {

	// The valid values for a control parameter that is an enum.
	AllowedValues []*string `type:"list"`

	// The Security Hub default value for a control parameter that is an enum.
	DefaultValue *string `type:"string"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is an enum.

func (EnumConfigurationOptions) GoString added in v1.48.4 

func (s EnumConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*EnumConfigurationOptions) SetAllowedValues added in v1.48.4 

func (s *EnumConfigurationOptions) SetAllowedValues(v []*string) *EnumConfigurationOptions

SetAllowedValues sets the AllowedValues field's value.

func (*EnumConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *EnumConfigurationOptions) SetDefaultValue(v string) *EnumConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (EnumConfigurationOptions) String added in v1.48.4 

func (s EnumConfigurationOptions) String() string

String returns the string representation.

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

type EnumListConfigurationOptions added in v1.48.4 

type EnumListConfigurationOptions struct {

	// The valid values for a control parameter that is a list of enums.
	AllowedValues []*string `type:"list"`

	// The Security Hub default value for a control parameter that is a list of
	// enums.
	DefaultValue []*string `type:"list"`

	// The maximum number of list items that an enum list control parameter can
	// accept.
	MaxItems *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is a list of enums.

func (EnumListConfigurationOptions) GoString added in v1.48.4 

func (s EnumListConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*EnumListConfigurationOptions) SetAllowedValues added in v1.48.4 

func (s *EnumListConfigurationOptions) SetAllowedValues(v []*string) *EnumListConfigurationOptions

SetAllowedValues sets the AllowedValues field's value.

func (*EnumListConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *EnumListConfigurationOptions) SetDefaultValue(v []*string) *EnumListConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (*EnumListConfigurationOptions) SetMaxItems added in v1.48.4 

func (s *EnumListConfigurationOptions) SetMaxItems(v int64) *EnumListConfigurationOptions

SetMaxItems sets the MaxItems field's value.

func (EnumListConfigurationOptions) String added in v1.48.4 

func (s EnumListConfigurationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *FilePaths) SetFileName(v string) *FilePaths

SetFileName sets the FileName field's value.

func (*FilePaths) SetFilePath added in v1.44.36 

func (s *FilePaths) SetFilePath(v string) *FilePaths

SetFilePath sets the FilePath field's value.

func (*FilePaths) SetHash added in v1.44.36 

func (s *FilePaths) SetHash(v string) *FilePaths

SetHash sets the Hash field's value.

func (*FilePaths) SetResourceId added in v1.44.36 

func (s *FilePaths) SetResourceId(v string) *FilePaths

SetResourceId sets the ResourceId field's value.

func (FilePaths) String added in v1.44.36 

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *FindingAggregator) SetFindingAggregatorArn(v string) *FindingAggregator

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (FindingAggregator) String added in v1.41.7 

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.44.257 

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"`

	// A timestamp that indicates when Security Hub processed the updated finding
	// record.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.44.257 

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.44.257 

func (s *FindingHistoryRecord) SetFindingCreated(v bool) *FindingHistoryRecord

SetFindingCreated sets the FindingCreated field's value.

func (*FindingHistoryRecord) SetFindingIdentifier added in v1.44.257 

func (s *FindingHistoryRecord) SetFindingIdentifier(v *AwsSecurityFindingIdentifier) *FindingHistoryRecord

SetFindingIdentifier sets the FindingIdentifier field's value.

func (*FindingHistoryRecord) SetNextToken added in v1.44.257 

func (s *FindingHistoryRecord) SetNextToken(v string) *FindingHistoryRecord

SetNextToken sets the NextToken field's value.

func (*FindingHistoryRecord) SetUpdateSource added in v1.44.257 

func (s *FindingHistoryRecord) SetUpdateSource(v *FindingHistoryUpdateSource) *FindingHistoryRecord

SetUpdateSource sets the UpdateSource field's value.

func (*FindingHistoryRecord) SetUpdateTime added in v1.44.257 

func (s *FindingHistoryRecord) SetUpdateTime(v time.Time) *FindingHistoryRecord

SetUpdateTime sets the UpdateTime field's value.

func (*FindingHistoryRecord) SetUpdates added in v1.44.257 

func (s *FindingHistoryRecord) SetUpdates(v []*FindingHistoryUpdate) *FindingHistoryRecord

SetUpdates sets the Updates field's value.

func (FindingHistoryRecord) String added in v1.44.257 

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.44.257 

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.44.257 

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.44.257 

func (s *FindingHistoryUpdate) SetNewValue(v string) *FindingHistoryUpdate

SetNewValue sets the NewValue field's value.

func (*FindingHistoryUpdate) SetOldValue added in v1.44.257 

func (s *FindingHistoryUpdate) SetOldValue(v string) *FindingHistoryUpdate

SetOldValue sets the OldValue field's value.

func (*FindingHistoryUpdate) SetUpdatedField added in v1.44.257 

func (s *FindingHistoryUpdate) SetUpdatedField(v string) *FindingHistoryUpdate

SetUpdatedField sets the UpdatedField field's value.

func (FindingHistoryUpdate) String added in v1.44.257 

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.44.257 

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.44.257 

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.44.257 

func (s *FindingHistoryUpdateSource) SetIdentity(v string) *FindingHistoryUpdateSource

SetIdentity sets the Identity field's value.

func (*FindingHistoryUpdateSource) SetType added in v1.44.257 

func (s *FindingHistoryUpdateSource) SetType(v string) *FindingHistoryUpdateSource

SetType sets the Type field's value.

func (FindingHistoryUpdateSource) String added in v1.44.257 

func (s FindingHistoryUpdateSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *FindingProviderFields) SetConfidence(v int64) *FindingProviderFields

SetConfidence sets the Confidence field's value.

func (*FindingProviderFields) SetCriticality added in v1.38.0 

func (s *FindingProviderFields) SetCriticality(v int64) *FindingProviderFields

SetCriticality sets the Criticality field's value.

func (*FindingProviderFields) SetRelatedFindings added in v1.38.0 

func (s *FindingProviderFields) SetRelatedFindings(v []*RelatedFinding) *FindingProviderFields

SetRelatedFindings sets the RelatedFindings field's value.

func (*FindingProviderFields) SetSeverity added in v1.38.0 

func (s *FindingProviderFields) SetSeverity(v *FindingProviderSeverity) *FindingProviderFields

SetSeverity sets the Severity field's value.

func (*FindingProviderFields) SetTypes added in v1.38.0 

func (s *FindingProviderFields) SetTypes(v []*string) *FindingProviderFields

SetTypes sets the Types field's value.

func (FindingProviderFields) String added in v1.38.0 

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 added in v1.38.0 

func (s *FindingProviderFields) Validate() error

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

type FindingProviderSeverity added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *FindingProviderSeverity) SetLabel(v string) *FindingProviderSeverity

SetLabel sets the Label field's value.

func (*FindingProviderSeverity) SetOriginal added in v1.38.0 

func (s *FindingProviderSeverity) SetOriginal(v string) *FindingProviderSeverity

SetOriginal sets the Original field's value.

func (FindingProviderSeverity) String added in v1.38.0 

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.24 

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.24 

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.24 

func (s *FirewallPolicyDetails) SetStatefulRuleGroupReferences(v []*FirewallPolicyStatefulRuleGroupReferencesDetails) *FirewallPolicyDetails

SetStatefulRuleGroupReferences sets the StatefulRuleGroupReferences field's value.

func (*FirewallPolicyDetails) SetStatelessCustomActions added in v1.42.24 

func (s *FirewallPolicyDetails) SetStatelessCustomActions(v []*FirewallPolicyStatelessCustomActionsDetails) *FirewallPolicyDetails

SetStatelessCustomActions sets the StatelessCustomActions field's value.

func (*FirewallPolicyDetails) SetStatelessDefaultActions added in v1.42.24 

func (s *FirewallPolicyDetails) SetStatelessDefaultActions(v []*string) *FirewallPolicyDetails

SetStatelessDefaultActions sets the StatelessDefaultActions field's value.

func (*FirewallPolicyDetails) SetStatelessFragmentDefaultActions added in v1.42.24 

func (s *FirewallPolicyDetails) SetStatelessFragmentDefaultActions(v []*string) *FirewallPolicyDetails

SetStatelessFragmentDefaultActions sets the StatelessFragmentDefaultActions field's value.

func (*FirewallPolicyDetails) SetStatelessRuleGroupReferences added in v1.42.24 

func (s *FirewallPolicyDetails) SetStatelessRuleGroupReferences(v []*FirewallPolicyStatelessRuleGroupReferencesDetails) *FirewallPolicyDetails

SetStatelessRuleGroupReferences sets the StatelessRuleGroupReferences field's value.

func (FirewallPolicyDetails) String added in v1.42.24 

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.24 

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.24 

func (s FirewallPolicyStatefulRuleGroupReferencesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *FirewallPolicyStatefulRuleGroupReferencesDetails) SetResourceArn(v string) *FirewallPolicyStatefulRuleGroupReferencesDetails

SetResourceArn sets the ResourceArn field's value.

func (FirewallPolicyStatefulRuleGroupReferencesDetails) String added in v1.42.24 

func (s FirewallPolicyStatefulRuleGroupReferencesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s FirewallPolicyStatelessCustomActionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *FirewallPolicyStatelessCustomActionsDetails) SetActionDefinition(v *StatelessCustomActionDefinition) *FirewallPolicyStatelessCustomActionsDetails

SetActionDefinition sets the ActionDefinition field's value.

func (*FirewallPolicyStatelessCustomActionsDetails) SetActionName added in v1.42.24 

func (s *FirewallPolicyStatelessCustomActionsDetails) SetActionName(v string) *FirewallPolicyStatelessCustomActionsDetails

SetActionName sets the ActionName field's value.

func (FirewallPolicyStatelessCustomActionsDetails) String added in v1.42.24 

func (s FirewallPolicyStatelessCustomActionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s FirewallPolicyStatelessRuleGroupReferencesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *FirewallPolicyStatelessRuleGroupReferencesDetails) SetPriority(v int64) *FirewallPolicyStatelessRuleGroupReferencesDetails

SetPriority sets the Priority field's value.

func (*FirewallPolicyStatelessRuleGroupReferencesDetails) SetResourceArn added in v1.42.24 

func (s *FirewallPolicyStatelessRuleGroupReferencesDetails) SetResourceArn(v string) *FirewallPolicyStatelessRuleGroupReferencesDetails

SetResourceArn sets the ResourceArn field's value.

func (FirewallPolicyStatelessRuleGroupReferencesDetails) String added in v1.42.24 

func (s FirewallPolicyStatelessRuleGroupReferencesDetails) String() string

String returns the string representation.

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

type GeneratorDetails added in v1.44.327 

type GeneratorDetails struct {

	// The description of the detector used to identify the code vulnerability.
	Description *string `type:"string"`

	// An array of tags used to identify the detector associated with the finding.
	Labels []*string `type:"list"`

	// The name of the detector used to identify the code vulnerability.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub receives those findings.

func (GeneratorDetails) GoString added in v1.44.327 

func (s GeneratorDetails) GoString() string

GoString returns the string representation.

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

func (*GeneratorDetails) SetDescription added in v1.44.327 

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

SetDescription sets the Description field's value.

func (*GeneratorDetails) SetLabels added in v1.44.327 

func (s *GeneratorDetails) SetLabels(v []*string) *GeneratorDetails

SetLabels sets the Labels field's value.

func (*GeneratorDetails) SetName added in v1.44.327 

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

SetName sets the Name field's value.

func (GeneratorDetails) String added in v1.44.327 

func (s GeneratorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *GeoLocation) SetLat(v float64) *GeoLocation

SetLat sets the Lat field's value.

func (*GeoLocation) SetLon added in v1.36.30 

func (s *GeoLocation) SetLon(v float64) *GeoLocation

SetLon sets the Lon field's value.

func (GeoLocation) String added in v1.36.30 

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 added in v1.38.24 

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

func (GetAdministratorAccountInput) GoString added in v1.38.24 

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 added in v1.38.24 

func (s GetAdministratorAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

type GetAdministratorAccountOutput struct {

	// Details about an invitation.
	Administrator *Invitation `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAdministratorAccountOutput) GoString added in v1.38.24 

func (s GetAdministratorAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.24 

func (s *GetAdministratorAccountOutput) SetAdministrator(v *Invitation) *GetAdministratorAccountOutput

SetAdministrator sets the Administrator field's value.

func (GetAdministratorAccountOutput) String added in v1.38.24 

func (s GetAdministratorAccountOutput) String() string

String returns the string representation.

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

type GetConfigurationPolicyAssociationInput added in v1.48.5 

type GetConfigurationPolicyAssociationInput struct {

	// The target account ID, organizational unit ID, or the root ID to retrieve
	// the association for.
	//
	// Target is a required field
	Target *Target `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfigurationPolicyAssociationInput) GoString added in v1.48.5 

func (s GetConfigurationPolicyAssociationInput) GoString() string

GoString returns the string representation.

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

func (*GetConfigurationPolicyAssociationInput) SetTarget added in v1.48.5 

func (s *GetConfigurationPolicyAssociationInput) SetTarget(v *Target) *GetConfigurationPolicyAssociationInput

SetTarget sets the Target field's value.

func (GetConfigurationPolicyAssociationInput) String added in v1.48.5 

func (s GetConfigurationPolicyAssociationInput) String() string

String returns the string representation.

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

func (*GetConfigurationPolicyAssociationInput) Validate added in v1.48.5 

func (s *GetConfigurationPolicyAssociationInput) Validate() error

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

type GetConfigurationPolicyAssociationOutput added in v1.48.5 

type GetConfigurationPolicyAssociationOutput struct {

	// The current status of the association between the specified target and the
	// configuration.
	AssociationStatus *string `type:"string" enum:"ConfigurationPolicyAssociationStatus"`

	// The explanation for a FAILED value for AssociationStatus.
	AssociationStatusMessage *string `type:"string"`

	// Indicates whether the association between the specified target and the configuration
	// was directly applied by the Security Hub delegated administrator or inherited
	// from a parent.
	AssociationType *string `type:"string" enum:"AssociationType"`

	// The universally unique identifier (UUID) of a configuration policy. For self-managed
	// behavior, the value is SELF_MANAGED_SECURITY_HUB.
	ConfigurationPolicyId *string `type:"string"`

	// The target account ID, organizational unit ID, or the root ID for which the
	// association is retrieved.
	TargetId *string `type:"string"`

	// Specifies whether the target is an Amazon Web Services account, organizational
	// unit, or the organization root.
	TargetType *string `type:"string" enum:"TargetType"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// association was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetConfigurationPolicyAssociationOutput) GoString added in v1.48.5 

func (s GetConfigurationPolicyAssociationOutput) GoString() string

GoString returns the string representation.

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

func (*GetConfigurationPolicyAssociationOutput) SetAssociationStatus added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetAssociationStatus(v string) *GetConfigurationPolicyAssociationOutput

SetAssociationStatus sets the AssociationStatus field's value.

func (*GetConfigurationPolicyAssociationOutput) SetAssociationStatusMessage added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetAssociationStatusMessage(v string) *GetConfigurationPolicyAssociationOutput

SetAssociationStatusMessage sets the AssociationStatusMessage field's value.

func (*GetConfigurationPolicyAssociationOutput) SetAssociationType added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetAssociationType(v string) *GetConfigurationPolicyAssociationOutput

SetAssociationType sets the AssociationType field's value.

func (*GetConfigurationPolicyAssociationOutput) SetConfigurationPolicyId added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetConfigurationPolicyId(v string) *GetConfigurationPolicyAssociationOutput

SetConfigurationPolicyId sets the ConfigurationPolicyId field's value.

func (*GetConfigurationPolicyAssociationOutput) SetTargetId added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetTargetId(v string) *GetConfigurationPolicyAssociationOutput

SetTargetId sets the TargetId field's value.

func (*GetConfigurationPolicyAssociationOutput) SetTargetType added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetTargetType(v string) *GetConfigurationPolicyAssociationOutput

SetTargetType sets the TargetType field's value.

func (*GetConfigurationPolicyAssociationOutput) SetUpdatedAt added in v1.48.5 

func (s *GetConfigurationPolicyAssociationOutput) SetUpdatedAt(v time.Time) *GetConfigurationPolicyAssociationOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetConfigurationPolicyAssociationOutput) String added in v1.48.5 

func (s GetConfigurationPolicyAssociationOutput) String() string

String returns the string representation.

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

type GetConfigurationPolicyInput added in v1.48.5 

type GetConfigurationPolicyInput struct {

	// The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
	// the configuration policy.
	//
	// Identifier is a required field
	Identifier *string `location:"uri" locationName:"Identifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfigurationPolicyInput) GoString added in v1.48.5 

func (s GetConfigurationPolicyInput) GoString() string

GoString returns the string representation.

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

func (*GetConfigurationPolicyInput) SetIdentifier added in v1.48.5 

func (s *GetConfigurationPolicyInput) SetIdentifier(v string) *GetConfigurationPolicyInput

SetIdentifier sets the Identifier field's value.

func (GetConfigurationPolicyInput) String added in v1.48.5 

func (s GetConfigurationPolicyInput) String() string

String returns the string representation.

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

func (*GetConfigurationPolicyInput) Validate added in v1.48.5 

func (s *GetConfigurationPolicyInput) Validate() error

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

type GetConfigurationPolicyOutput added in v1.48.5 

type GetConfigurationPolicyOutput struct {

	// The ARN of the configuration policy.
	Arn *string `type:"string"`

	// An object that defines how Security Hub is configured. It includes whether
	// Security Hub is enabled or disabled, a list of enabled security standards,
	// a list of enabled or disabled security controls, and a list of custom parameter
	// values for specified controls. If the policy includes a list of security
	// controls that are enabled, Security Hub disables all other controls (including
	// newly released controls). If the policy includes a list of security controls
	// that are disabled, Security Hub enables all other controls (including newly
	// released controls).
	ConfigurationPolicy *Policy `type:"structure"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

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

	// The UUID of the configuration policy.
	Id *string `type:"string"`

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

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetConfigurationPolicyOutput) GoString added in v1.48.5 

func (s GetConfigurationPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*GetConfigurationPolicyOutput) SetArn added in v1.48.5 

func (s *GetConfigurationPolicyOutput) SetArn(v string) *GetConfigurationPolicyOutput

SetArn sets the Arn field's value.

func (*GetConfigurationPolicyOutput) SetConfigurationPolicy added in v1.48.5 

func (s *GetConfigurationPolicyOutput) SetConfigurationPolicy(v *Policy) *GetConfigurationPolicyOutput

SetConfigurationPolicy sets the ConfigurationPolicy field's value.

func (*GetConfigurationPolicyOutput) SetCreatedAt added in v1.48.5 

func (s *GetConfigurationPolicyOutput) SetCreatedAt(v time.Time) *GetConfigurationPolicyOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetConfigurationPolicyOutput) SetDescription added in v1.48.5 

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

SetDescription sets the Description field's value.

func (*GetConfigurationPolicyOutput) SetId added in v1.48.5 

func (s *GetConfigurationPolicyOutput) SetId(v string) *GetConfigurationPolicyOutput

SetId sets the Id field's value.

func (*GetConfigurationPolicyOutput) SetName added in v1.48.5 

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

SetName sets the Name field's value.

func (*GetConfigurationPolicyOutput) SetUpdatedAt added in v1.48.5 

func (s *GetConfigurationPolicyOutput) SetUpdatedAt(v time.Time) *GetConfigurationPolicyOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetConfigurationPolicyOutput) String added in v1.48.5 

func (s GetConfigurationPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *GetEnabledStandardsInput) SetMaxResults(v int64) *GetEnabledStandardsInput

SetMaxResults sets the MaxResults field's value.

func (*GetEnabledStandardsInput) SetNextToken 

func (s *GetEnabledStandardsInput) SetNextToken(v string) *GetEnabledStandardsInput

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 

func (s *GetEnabledStandardsOutput) SetNextToken(v string) *GetEnabledStandardsOutput

SetNextToken sets the NextToken field's value.

func (*GetEnabledStandardsOutput) SetStandardsSubscriptions 

func (s *GetEnabledStandardsOutput) SetStandardsSubscriptions(v []*StandardsSubscription) *GetEnabledStandardsOutput

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *GetFindingAggregatorInput) SetFindingAggregatorArn(v string) *GetFindingAggregatorInput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (GetFindingAggregatorInput) String added in v1.41.7 

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 added in v1.41.7 

func (s *GetFindingAggregatorInput) Validate() error

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

type GetFindingAggregatorOutput added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *GetFindingAggregatorOutput) SetFindingAggregationRegion(v string) *GetFindingAggregatorOutput

SetFindingAggregationRegion sets the FindingAggregationRegion field's value.

func (*GetFindingAggregatorOutput) SetFindingAggregatorArn added in v1.41.7 

func (s *GetFindingAggregatorOutput) SetFindingAggregatorArn(v string) *GetFindingAggregatorOutput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*GetFindingAggregatorOutput) SetRegionLinkingMode added in v1.41.7 

func (s *GetFindingAggregatorOutput) SetRegionLinkingMode(v string) *GetFindingAggregatorOutput

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*GetFindingAggregatorOutput) SetRegions added in v1.41.7 

func (s *GetFindingAggregatorOutput) SetRegions(v []*string) *GetFindingAggregatorOutput

SetRegions sets the Regions field's value.

func (GetFindingAggregatorOutput) String added in v1.41.7 

func (s GetFindingAggregatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.257 

type GetFindingHistoryInput struct {

	// An ISO 8601-formatted timestamp that indicates the end time of the requested
	// finding history.
	//
	// 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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"`

	// A timestamp that indicates the start time of the requested finding history.
	//
	// 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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetFindingHistoryInput) GoString added in v1.44.257 

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.44.257 

func (s *GetFindingHistoryInput) SetEndTime(v time.Time) *GetFindingHistoryInput

SetEndTime sets the EndTime field's value.

func (*GetFindingHistoryInput) SetFindingIdentifier added in v1.44.257 

func (s *GetFindingHistoryInput) SetFindingIdentifier(v *AwsSecurityFindingIdentifier) *GetFindingHistoryInput

SetFindingIdentifier sets the FindingIdentifier field's value.

func (*GetFindingHistoryInput) SetMaxResults added in v1.44.257 

func (s *GetFindingHistoryInput) SetMaxResults(v int64) *GetFindingHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetFindingHistoryInput) SetNextToken added in v1.44.257 

func (s *GetFindingHistoryInput) SetNextToken(v string) *GetFindingHistoryInput

SetNextToken sets the NextToken field's value.

func (*GetFindingHistoryInput) SetStartTime added in v1.44.257 

func (s *GetFindingHistoryInput) SetStartTime(v time.Time) *GetFindingHistoryInput

SetStartTime sets the StartTime field's value.

func (GetFindingHistoryInput) String added in v1.44.257 

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.44.257 

func (s *GetFindingHistoryInput) Validate() error

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

type GetFindingHistoryOutput added in v1.44.257 

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.44.257 

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.44.257 

func (s *GetFindingHistoryOutput) SetNextToken(v string) *GetFindingHistoryOutput

SetNextToken sets the NextToken field's value.

func (*GetFindingHistoryOutput) SetRecords added in v1.44.257 

func (s *GetFindingHistoryOutput) SetRecords(v []*FindingHistoryRecord) *GetFindingHistoryOutput

SetRecords sets the Records field's value.

func (GetFindingHistoryOutput) String added in v1.44.257 

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 

func (s *GetFindingsInput) SetFilters(v *AwsSecurityFindingFilters) *GetFindingsInput

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 

func (s *GetFindingsOutput) SetFindings(v []*AwsSecurityFinding) *GetFindingsOutput

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 

func (s *GetInsightResultsInput) SetInsightArn(v string) *GetInsightResultsInput

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 

func (s *GetInsightResultsOutput) SetInsightResults(v *InsightResults) *GetInsightResultsOutput

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 

func (s *GetMasterAccountOutput) SetMaster(v *Invitation) *GetMasterAccountOutput

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 GetSecurityControlDefinitionInput added in v1.48.4 

type GetSecurityControlDefinitionInput struct {

	// The ID of the security control to retrieve the definition for. This field
	// doesn’t accept an Amazon Resource Name (ARN).
	//
	// SecurityControlId is a required field
	SecurityControlId *string `location:"querystring" locationName:"SecurityControlId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSecurityControlDefinitionInput) GoString added in v1.48.4 

func (s GetSecurityControlDefinitionInput) GoString() string

GoString returns the string representation.

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

func (*GetSecurityControlDefinitionInput) SetSecurityControlId added in v1.48.4 

func (s *GetSecurityControlDefinitionInput) SetSecurityControlId(v string) *GetSecurityControlDefinitionInput

SetSecurityControlId sets the SecurityControlId field's value.

func (GetSecurityControlDefinitionInput) String added in v1.48.4 

func (s GetSecurityControlDefinitionInput) String() string

String returns the string representation.

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

func (*GetSecurityControlDefinitionInput) Validate added in v1.48.4 

func (s *GetSecurityControlDefinitionInput) Validate() error

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

type GetSecurityControlDefinitionOutput added in v1.48.4 

type GetSecurityControlDefinitionOutput struct {

	// 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.
	//
	// SecurityControlDefinition is a required field
	SecurityControlDefinition *SecurityControlDefinition `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSecurityControlDefinitionOutput) GoString added in v1.48.4 

func (s GetSecurityControlDefinitionOutput) GoString() string

GoString returns the string representation.

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

func (*GetSecurityControlDefinitionOutput) SetSecurityControlDefinition added in v1.48.4 

func (s *GetSecurityControlDefinitionOutput) SetSecurityControlDefinition(v *SecurityControlDefinition) *GetSecurityControlDefinitionOutput

SetSecurityControlDefinition sets the SecurityControlDefinition field's value.

func (GetSecurityControlDefinitionOutput) String added in v1.48.4 

func (s GetSecurityControlDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

func (s *IcmpTypeCode) SetCode(v int64) *IcmpTypeCode

SetCode sets the Code field's value.

func (*IcmpTypeCode) SetType added in v1.38.31 

func (s *IcmpTypeCode) SetType(v int64) *IcmpTypeCode

SetType sets the Type field's value.

func (IcmpTypeCode) String added in v1.38.31 

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 

func (s *ImportFindingsError) SetId(v string) *ImportFindingsError

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.
	// You can filter by up to ten finding attributes. For each attribute, you can
	// provide up to 20 filter values. 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 

func (s *InsightResultValue) SetCount(v int64) *InsightResultValue

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 IntegerConfigurationOptions added in v1.48.4 

type IntegerConfigurationOptions struct {

	// The Security Hub default value for a control parameter that is an integer.
	DefaultValue *int64 `type:"integer"`

	// The maximum valid value for a control parameter that is an integer.
	Max *int64 `type:"integer"`

	// The minimum valid value for a control parameter that is an integer.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is an integer.

func (IntegerConfigurationOptions) GoString added in v1.48.4 

func (s IntegerConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*IntegerConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *IntegerConfigurationOptions) SetDefaultValue(v int64) *IntegerConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (*IntegerConfigurationOptions) SetMax added in v1.48.4 

func (s *IntegerConfigurationOptions) SetMax(v int64) *IntegerConfigurationOptions

SetMax sets the Max field's value.

func (*IntegerConfigurationOptions) SetMin added in v1.48.4 

func (s *IntegerConfigurationOptions) SetMin(v int64) *IntegerConfigurationOptions

SetMin sets the Min field's value.

func (IntegerConfigurationOptions) String added in v1.48.4 

func (s IntegerConfigurationOptions) String() string

String returns the string representation.

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

type IntegerListConfigurationOptions added in v1.48.4 

type IntegerListConfigurationOptions struct {

	// The Security Hub default value for a control parameter that is a list of
	// integers.
	DefaultValue []*int64 `type:"list"`

	// The maximum valid value for a control parameter that is a list of integers.
	Max *int64 `type:"integer"`

	// The maximum number of list items that an interger list control parameter
	// can accept.
	MaxItems *int64 `type:"integer"`

	// The minimum valid value for a control parameter that is a list of integers.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is a list of integers.

func (IntegerListConfigurationOptions) GoString added in v1.48.4 

func (s IntegerListConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*IntegerListConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *IntegerListConfigurationOptions) SetDefaultValue(v []*int64) *IntegerListConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (*IntegerListConfigurationOptions) SetMax added in v1.48.4 

func (s *IntegerListConfigurationOptions) SetMax(v int64) *IntegerListConfigurationOptions

SetMax sets the Max field's value.

func (*IntegerListConfigurationOptions) SetMaxItems added in v1.48.4 

func (s *IntegerListConfigurationOptions) SetMaxItems(v int64) *IntegerListConfigurationOptions

SetMaxItems sets the MaxItems field's value.

func (*IntegerListConfigurationOptions) SetMin added in v1.48.4 

func (s *IntegerListConfigurationOptions) SetMin(v int64) *IntegerListConfigurationOptions

SetMin sets the Min field's value.

func (IntegerListConfigurationOptions) String added in v1.48.4 

func (s IntegerListConfigurationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.0 

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 added in v1.28.0 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error added in v1.28.0 

func (s *InternalException) Error() string

func (InternalException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr added in v1.28.0 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID added in v1.28.0 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode added in v1.28.0 

func (s *InternalException) StatusCode() int

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

func (InternalException) String added in v1.28.0 

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 added in v1.28.0 

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 added in v1.28.0 

func (s *InvalidAccessException) Code() string

Code returns the exception type name.

func (*InvalidAccessException) Error added in v1.28.0 

func (s *InvalidAccessException) Error() string

func (InvalidAccessException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *InvalidAccessException) Message() string

Message returns the exception's message.

func (*InvalidAccessException) OrigErr added in v1.28.0 

func (s *InvalidAccessException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidAccessException) RequestID added in v1.28.0 

func (s *InvalidAccessException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidAccessException) StatusCode added in v1.28.0 

func (s *InvalidAccessException) StatusCode() int

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

func (InvalidAccessException) String added in v1.28.0 

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 added in v1.28.0 

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 added in v1.28.0 

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error added in v1.28.0 

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr added in v1.28.0 

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID added in v1.28.0 

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode added in v1.28.0 

func (s *InvalidInputException) StatusCode() int

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

func (InvalidInputException) String added in v1.28.0 

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 added in v1.35.34 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *IpOrganizationDetails) SetAsn(v int64) *IpOrganizationDetails

SetAsn sets the Asn field's value.

func (*IpOrganizationDetails) SetAsnOrg added in v1.36.30 

func (s *IpOrganizationDetails) SetAsnOrg(v string) *IpOrganizationDetails

SetAsnOrg sets the AsnOrg field's value.

func (*IpOrganizationDetails) SetIsp added in v1.36.30 

func (s *IpOrganizationDetails) SetIsp(v string) *IpOrganizationDetails

SetIsp sets the Isp field's value.

func (*IpOrganizationDetails) SetOrg added in v1.36.30 

func (s *IpOrganizationDetails) SetOrg(v string) *IpOrganizationDetails

SetOrg sets the Org field's value.

func (IpOrganizationDetails) String added in v1.36.30 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *Ipv6CidrBlockAssociation) SetAssociationId(v string) *Ipv6CidrBlockAssociation

SetAssociationId sets the AssociationId field's value.

func (*Ipv6CidrBlockAssociation) SetCidrBlockState added in v1.33.0 

func (s *Ipv6CidrBlockAssociation) SetCidrBlockState(v string) *Ipv6CidrBlockAssociation

SetCidrBlockState sets the CidrBlockState field's value.

func (*Ipv6CidrBlockAssociation) SetIpv6CidrBlock added in v1.33.0 

func (s *Ipv6CidrBlockAssociation) SetIpv6CidrBlock(v string) *Ipv6CidrBlockAssociation

SetIpv6CidrBlock sets the Ipv6CidrBlock field's value.

func (Ipv6CidrBlockAssociation) String added in v1.33.0 

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 added in v1.28.0 

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 added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String added in v1.28.0 

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.44.282 

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.44.282 

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.44.282 

func (s *ListAutomationRulesInput) SetMaxResults(v int64) *ListAutomationRulesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAutomationRulesInput) SetNextToken added in v1.44.282 

func (s *ListAutomationRulesInput) SetNextToken(v string) *ListAutomationRulesInput

SetNextToken sets the NextToken field's value.

func (ListAutomationRulesInput) String added in v1.44.282 

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.44.282 

func (s *ListAutomationRulesInput) Validate() error

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

type ListAutomationRulesOutput added in v1.44.282 

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.44.282 

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.44.282 

func (s *ListAutomationRulesOutput) SetAutomationRulesMetadata(v []*AutomationRulesMetadata) *ListAutomationRulesOutput

SetAutomationRulesMetadata sets the AutomationRulesMetadata field's value.

func (*ListAutomationRulesOutput) SetNextToken added in v1.44.282 

func (s *ListAutomationRulesOutput) SetNextToken(v string) *ListAutomationRulesOutput

SetNextToken sets the NextToken field's value.

func (ListAutomationRulesOutput) String added in v1.44.282 

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 ListConfigurationPoliciesInput added in v1.48.5 

type ListConfigurationPoliciesInput struct {

	// The maximum number of results that's returned by ListConfigurationPolicies
	// in each page of the response. When this parameter is used, ListConfigurationPolicies
	// returns the specified number of results in a single page and a NextToken
	// response element. You can see the remaining results of the initial request
	// by sending another ListConfigurationPolicies request with the returned NextToken
	// value. A valid range for MaxResults is between 1 and 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The NextToken value that's returned from a previous paginated ListConfigurationPolicies
	// request where MaxResults was used but the results exceeded the value of that
	// parameter. Pagination continues from the MaxResults was used but the results
	// exceeded the value of that parameter. Pagination continues from the end of
	// the previous response that returned the NextToken value. This value is null
	// when there are no more results to return.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListConfigurationPoliciesInput) GoString added in v1.48.5 

func (s ListConfigurationPoliciesInput) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationPoliciesInput) SetMaxResults added in v1.48.5 

func (s *ListConfigurationPoliciesInput) SetMaxResults(v int64) *ListConfigurationPoliciesInput

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationPoliciesInput) SetNextToken added in v1.48.5 

func (s *ListConfigurationPoliciesInput) SetNextToken(v string) *ListConfigurationPoliciesInput

SetNextToken sets the NextToken field's value.

func (ListConfigurationPoliciesInput) String added in v1.48.5 

func (s ListConfigurationPoliciesInput) String() string

String returns the string representation.

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

func (*ListConfigurationPoliciesInput) Validate added in v1.48.5 

func (s *ListConfigurationPoliciesInput) Validate() error

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

type ListConfigurationPoliciesOutput added in v1.48.5 

type ListConfigurationPoliciesOutput struct {

	// Provides metadata for each of your configuration policies.
	ConfigurationPolicySummaries []*ConfigurationPolicySummary `type:"list"`

	// The NextToken value to include in the next ListConfigurationPolicies request.
	// When the results of a ListConfigurationPolicies request exceed MaxResults,
	// this value can be used to retrieve the next page of results. This value is
	// null when there are no more results to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListConfigurationPoliciesOutput) GoString added in v1.48.5 

func (s ListConfigurationPoliciesOutput) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationPoliciesOutput) SetConfigurationPolicySummaries added in v1.48.5 

func (s *ListConfigurationPoliciesOutput) SetConfigurationPolicySummaries(v []*ConfigurationPolicySummary) *ListConfigurationPoliciesOutput

SetConfigurationPolicySummaries sets the ConfigurationPolicySummaries field's value.

func (*ListConfigurationPoliciesOutput) SetNextToken added in v1.48.5 

func (s *ListConfigurationPoliciesOutput) SetNextToken(v string) *ListConfigurationPoliciesOutput

SetNextToken sets the NextToken field's value.

func (ListConfigurationPoliciesOutput) String added in v1.48.5 

func (s ListConfigurationPoliciesOutput) String() string

String returns the string representation.

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

type ListConfigurationPolicyAssociationsInput added in v1.48.5 

type ListConfigurationPolicyAssociationsInput struct {

	// Options for filtering the ListConfigurationPolicyAssociations response. You
	// can filter by the Amazon Resource Name (ARN) or universally unique identifier
	// (UUID) of a configuration, AssociationType, or AssociationStatus.
	Filters *AssociationFilters `type:"structure"`

	// The maximum number of results that's returned by ListConfigurationPolicies
	// in each page of the response. When this parameter is used, ListConfigurationPolicyAssociations
	// returns the specified number of results in a single page and a NextToken
	// response element. You can see the remaining results of the initial request
	// by sending another ListConfigurationPolicyAssociations request with the returned
	// NextToken value. A valid range for MaxResults is between 1 and 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that's returned from a previous paginated ListConfigurationPolicyAssociations
	// request where MaxResults was used but the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous response that
	// returned the NextToken value. This value is null when there are no more results
	// to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListConfigurationPolicyAssociationsInput) GoString added in v1.48.5 

func (s ListConfigurationPolicyAssociationsInput) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationPolicyAssociationsInput) SetFilters added in v1.48.5 

func (s *ListConfigurationPolicyAssociationsInput) SetFilters(v *AssociationFilters) *ListConfigurationPolicyAssociationsInput

SetFilters sets the Filters field's value.

func (*ListConfigurationPolicyAssociationsInput) SetMaxResults added in v1.48.5 

func (s *ListConfigurationPolicyAssociationsInput) SetMaxResults(v int64) *ListConfigurationPolicyAssociationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationPolicyAssociationsInput) SetNextToken added in v1.48.5 

func (s *ListConfigurationPolicyAssociationsInput) SetNextToken(v string) *ListConfigurationPolicyAssociationsInput

SetNextToken sets the NextToken field's value.

func (ListConfigurationPolicyAssociationsInput) String added in v1.48.5 

func (s ListConfigurationPolicyAssociationsInput) String() string

String returns the string representation.

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

func (*ListConfigurationPolicyAssociationsInput) Validate added in v1.48.5 

func (s *ListConfigurationPolicyAssociationsInput) Validate() error

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

type ListConfigurationPolicyAssociationsOutput added in v1.48.5 

type ListConfigurationPolicyAssociationsOutput struct {

	// An object that contains the details of each configuration policy association
	// that’s returned in a ListConfigurationPolicyAssociations request.
	ConfigurationPolicyAssociationSummaries []*ConfigurationPolicyAssociationSummary `type:"list"`

	// The NextToken value to include in the next ListConfigurationPolicyAssociations
	// request. When the results of a ListConfigurationPolicyAssociations request
	// exceed MaxResults, this value can be used to retrieve the next page of results.
	// This value is null when there are no more results to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListConfigurationPolicyAssociationsOutput) GoString added in v1.48.5 

func (s ListConfigurationPolicyAssociationsOutput) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationPolicyAssociationsOutput) SetConfigurationPolicyAssociationSummaries added in v1.48.5 

func (s *ListConfigurationPolicyAssociationsOutput) SetConfigurationPolicyAssociationSummaries(v []*ConfigurationPolicyAssociationSummary) *ListConfigurationPolicyAssociationsOutput

SetConfigurationPolicyAssociationSummaries sets the ConfigurationPolicyAssociationSummaries field's value.

func (*ListConfigurationPolicyAssociationsOutput) SetNextToken added in v1.48.5 

func (s *ListConfigurationPolicyAssociationsOutput) SetNextToken(v string) *ListConfigurationPolicyAssociationsOutput

SetNextToken sets the NextToken field's value.

func (ListConfigurationPolicyAssociationsOutput) String added in v1.48.5 

func (s ListConfigurationPolicyAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s ListEnabledProductsForImportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *ListEnabledProductsForImportInput) SetMaxResults(v int64) *ListEnabledProductsForImportInput

SetMaxResults sets the MaxResults field's value.

func (*ListEnabledProductsForImportInput) SetNextToken 

func (s *ListEnabledProductsForImportInput) SetNextToken(v string) *ListEnabledProductsForImportInput

SetNextToken sets the NextToken field's value.

func (ListEnabledProductsForImportInput) String 

func (s ListEnabledProductsForImportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *ListEnabledProductsForImportInput) Validate() error

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 

func (s ListEnabledProductsForImportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *ListEnabledProductsForImportOutput) SetNextToken(v string) *ListEnabledProductsForImportOutput

SetNextToken sets the NextToken field's value.

func (*ListEnabledProductsForImportOutput) SetProductSubscriptions 

func (s *ListEnabledProductsForImportOutput) SetProductSubscriptions(v []*string) *ListEnabledProductsForImportOutput

SetProductSubscriptions sets the ProductSubscriptions field's value.

func (ListEnabledProductsForImportOutput) String 

func (s ListEnabledProductsForImportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *ListFindingAggregatorsInput) SetMaxResults(v int64) *ListFindingAggregatorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFindingAggregatorsInput) SetNextToken added in v1.41.7 

func (s *ListFindingAggregatorsInput) SetNextToken(v string) *ListFindingAggregatorsInput

SetNextToken sets the NextToken field's value.

func (ListFindingAggregatorsInput) String added in v1.41.7 

func (s ListFindingAggregatorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s *ListFindingAggregatorsInput) Validate() error

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

type ListFindingAggregatorsOutput added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *ListFindingAggregatorsOutput) SetFindingAggregators(v []*FindingAggregator) *ListFindingAggregatorsOutput

SetFindingAggregators sets the FindingAggregators field's value.

func (*ListFindingAggregatorsOutput) SetNextToken added in v1.41.7 

func (s *ListFindingAggregatorsOutput) SetNextToken(v string) *ListFindingAggregatorsOutput

SetNextToken sets the NextToken field's value.

func (ListFindingAggregatorsOutput) String added in v1.41.7 

func (s ListFindingAggregatorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *ListInvitationsOutput) SetNextToken(v string) *ListInvitationsOutput

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 added in v1.35.34 

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 added in v1.35.34 

func (s ListOrganizationAdminAccountsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *ListOrganizationAdminAccountsInput) SetMaxResults(v int64) *ListOrganizationAdminAccountsInput

SetMaxResults sets the MaxResults field's value.

func (*ListOrganizationAdminAccountsInput) SetNextToken added in v1.35.34 

func (s *ListOrganizationAdminAccountsInput) SetNextToken(v string) *ListOrganizationAdminAccountsInput

SetNextToken sets the NextToken field's value.

func (ListOrganizationAdminAccountsInput) String added in v1.35.34 

func (s ListOrganizationAdminAccountsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *ListOrganizationAdminAccountsInput) Validate() error

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

type ListOrganizationAdminAccountsOutput added in v1.35.34 

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 added in v1.35.34 

func (s ListOrganizationAdminAccountsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *ListOrganizationAdminAccountsOutput) SetAdminAccounts(v []*AdminAccount) *ListOrganizationAdminAccountsOutput

SetAdminAccounts sets the AdminAccounts field's value.

func (*ListOrganizationAdminAccountsOutput) SetNextToken added in v1.35.34 

func (s *ListOrganizationAdminAccountsOutput) SetNextToken(v string) *ListOrganizationAdminAccountsOutput

SetNextToken sets the NextToken field's value.

func (ListOrganizationAdminAccountsOutput) String added in v1.35.34 

func (s ListOrganizationAdminAccountsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s ListSecurityControlDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *ListSecurityControlDefinitionsInput) SetMaxResults(v int64) *ListSecurityControlDefinitionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityControlDefinitionsInput) SetNextToken added in v1.44.209 

func (s *ListSecurityControlDefinitionsInput) SetNextToken(v string) *ListSecurityControlDefinitionsInput

SetNextToken sets the NextToken field's value.

func (*ListSecurityControlDefinitionsInput) SetStandardsArn added in v1.44.209 

func (s *ListSecurityControlDefinitionsInput) SetStandardsArn(v string) *ListSecurityControlDefinitionsInput

SetStandardsArn sets the StandardsArn field's value.

func (ListSecurityControlDefinitionsInput) String added in v1.44.209 

func (s ListSecurityControlDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *ListSecurityControlDefinitionsInput) Validate() error

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

type ListSecurityControlDefinitionsOutput added in v1.44.209 

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.44.209 

func (s ListSecurityControlDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *ListSecurityControlDefinitionsOutput) SetNextToken(v string) *ListSecurityControlDefinitionsOutput

SetNextToken sets the NextToken field's value.

func (*ListSecurityControlDefinitionsOutput) SetSecurityControlDefinitions added in v1.44.209 

func (s *ListSecurityControlDefinitionsOutput) SetSecurityControlDefinitions(v []*SecurityControlDefinition) *ListSecurityControlDefinitionsOutput

SetSecurityControlDefinitions sets the SecurityControlDefinitions field's value.

func (ListSecurityControlDefinitionsOutput) String added in v1.44.209 

func (s ListSecurityControlDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s ListStandardsControlAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *ListStandardsControlAssociationsInput) SetMaxResults(v int64) *ListStandardsControlAssociationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStandardsControlAssociationsInput) SetNextToken added in v1.44.209 

func (s *ListStandardsControlAssociationsInput) SetNextToken(v string) *ListStandardsControlAssociationsInput

SetNextToken sets the NextToken field's value.

func (*ListStandardsControlAssociationsInput) SetSecurityControlId added in v1.44.209 

func (s *ListStandardsControlAssociationsInput) SetSecurityControlId(v string) *ListStandardsControlAssociationsInput

SetSecurityControlId sets the SecurityControlId field's value.

func (ListStandardsControlAssociationsInput) String added in v1.44.209 

func (s ListStandardsControlAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *ListStandardsControlAssociationsInput) Validate() error

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

type ListStandardsControlAssociationsOutput added in v1.44.209 

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.44.209 

func (s ListStandardsControlAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *ListStandardsControlAssociationsOutput) SetNextToken(v string) *ListStandardsControlAssociationsOutput

SetNextToken sets the NextToken field's value.

func (*ListStandardsControlAssociationsOutput) SetStandardsControlAssociationSummaries added in v1.44.209 

func (s *ListStandardsControlAssociationsOutput) SetStandardsControlAssociationSummaries(v []*StandardsControlAssociationSummary) *ListStandardsControlAssociationsOutput

SetStandardsControlAssociationSummaries sets the StandardsControlAssociationSummaries field's value.

func (ListStandardsControlAssociationsOutput) String added in v1.44.209 

func (s ListStandardsControlAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.20.7 

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 added in v1.20.7 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.20.7 

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 added in v1.26.7 

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 added in v1.26.7 

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 added in v1.26.7 

func (s *LoadBalancerState) SetCode(v string) *LoadBalancerState

SetCode sets the Code field's value.

func (*LoadBalancerState) SetReason added in v1.26.7 

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

SetReason sets the Reason field's value.

func (LoadBalancerState) String added in v1.26.7 

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 added in v1.38.24 

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 added in v1.33.0 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *NetworkConnectionAction) SetBlocked(v bool) *NetworkConnectionAction

SetBlocked sets the Blocked field's value.

func (*NetworkConnectionAction) SetConnectionDirection added in v1.36.30 

func (s *NetworkConnectionAction) SetConnectionDirection(v string) *NetworkConnectionAction

SetConnectionDirection sets the ConnectionDirection field's value.

func (*NetworkConnectionAction) SetLocalPortDetails added in v1.36.30 

func (s *NetworkConnectionAction) SetLocalPortDetails(v *ActionLocalPortDetails) *NetworkConnectionAction

SetLocalPortDetails sets the LocalPortDetails field's value.

func (*NetworkConnectionAction) SetProtocol added in v1.36.30 

func (s *NetworkConnectionAction) SetProtocol(v string) *NetworkConnectionAction

SetProtocol sets the Protocol field's value.

func (*NetworkConnectionAction) SetRemoteIpDetails added in v1.36.30 

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

SetRemoteIpDetails sets the RemoteIpDetails field's value.

func (*NetworkConnectionAction) SetRemotePortDetails added in v1.36.30 

func (s *NetworkConnectionAction) SetRemotePortDetails(v *ActionRemotePortDetails) *NetworkConnectionAction

SetRemotePortDetails sets the RemotePortDetails field's value.

func (NetworkConnectionAction) String added in v1.36.30 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *NetworkHeader) SetDestination(v *NetworkPathComponentDetails) *NetworkHeader

SetDestination sets the Destination field's value.

func (*NetworkHeader) SetProtocol added in v1.33.0 

func (s *NetworkHeader) SetProtocol(v string) *NetworkHeader

SetProtocol sets the Protocol field's value.

func (*NetworkHeader) SetSource added in v1.33.0 

func (s *NetworkHeader) SetSource(v *NetworkPathComponentDetails) *NetworkHeader

SetSource sets the Source field's value.

func (NetworkHeader) String added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *NetworkPathComponent) SetComponentId(v string) *NetworkPathComponent

SetComponentId sets the ComponentId field's value.

func (*NetworkPathComponent) SetComponentType added in v1.33.0 

func (s *NetworkPathComponent) SetComponentType(v string) *NetworkPathComponent

SetComponentType sets the ComponentType field's value.

func (*NetworkPathComponent) SetEgress added in v1.33.0 

func (s *NetworkPathComponent) SetEgress(v *NetworkHeader) *NetworkPathComponent

SetEgress sets the Egress field's value.

func (*NetworkPathComponent) SetIngress added in v1.33.0 

func (s *NetworkPathComponent) SetIngress(v *NetworkHeader) *NetworkPathComponent

SetIngress sets the Ingress field's value.

func (NetworkPathComponent) String added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *NetworkPathComponentDetails) SetAddress(v []*string) *NetworkPathComponentDetails

SetAddress sets the Address field's value.

func (*NetworkPathComponentDetails) SetPortRanges added in v1.33.0 

func (s *NetworkPathComponentDetails) SetPortRanges(v []*PortRange) *NetworkPathComponentDetails

SetPortRanges sets the PortRanges field's value.

func (NetworkPathComponentDetails) String added in v1.33.0 

func (s NetworkPathComponentDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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"`

	// A timestamp that indicates when the note was updated.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	//
	// 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 condition to be applied to a single field when querying
	// for findings.
	Gt *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 condition to be applied to a single field when querying for
	// findings.
	Lt *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) SetGt added in v1.48.4 

func (s *NumberFilter) SetGt(v float64) *NumberFilter

SetGt sets the Gt field's value.

func (*NumberFilter) SetGte 

func (s *NumberFilter) SetGte(v float64) *NumberFilter

SetGte sets the Gte field's value.

func (*NumberFilter) SetLt added in v1.48.4 

func (s *NumberFilter) SetLt(v float64) *NumberFilter

SetLt sets the Lt 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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *Occurrences) SetCells(v []*Cell) *Occurrences

SetCells sets the Cells field's value.

func (*Occurrences) SetLineRanges added in v1.38.0 

func (s *Occurrences) SetLineRanges(v []*Range) *Occurrences

SetLineRanges sets the LineRanges field's value.

func (*Occurrences) SetOffsetRanges added in v1.38.0 

func (s *Occurrences) SetOffsetRanges(v []*Range) *Occurrences

SetOffsetRanges sets the OffsetRanges field's value.

func (*Occurrences) SetPages added in v1.38.0 

func (s *Occurrences) SetPages(v []*Page) *Occurrences

SetPages sets the Pages field's value.

func (*Occurrences) SetRecords added in v1.38.0 

func (s *Occurrences) SetRecords(v []*Record) *Occurrences

SetRecords sets the Records field's value.

func (Occurrences) String added in v1.38.0 

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 OrganizationConfiguration added in v1.48.5 

type OrganizationConfiguration struct {

	// Indicates whether the organization uses local or central configuration.
	//
	// If you use local configuration, the Security Hub delegated administrator
	// can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically
	// enables Security Hub and default security standards in new organization accounts.
	// These new account settings must be set separately in each Amazon Web Services
	// Region, and settings may be different in each Region.
	//
	// If you use central configuration, the delegated administrator can create
	// configuration policies. Configuration policies can be used to configure Security
	// Hub, security standards, and security controls in multiple accounts and Regions.
	// If you want new organization accounts to use a specific configuration, you
	// can create a configuration policy and associate it with the root or specific
	// organizational units (OUs). New accounts will inherit the policy from the
	// root or their assigned OU.
	ConfigurationType *string `type:"string" enum:"OrganizationConfigurationConfigurationType"`

	// Describes whether central configuration could be enabled as the ConfigurationType
	// for the organization. If your ConfigurationType is local configuration, then
	// the value of Status is always ENABLED.
	Status *string `type:"string" enum:"OrganizationConfigurationStatus"`

	// Provides an explanation if the value of Status is equal to FAILED when ConfigurationType
	// is equal to CENTRAL.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the way an organization is configured in Security Hub.

func (OrganizationConfiguration) GoString added in v1.48.5 

func (s OrganizationConfiguration) GoString() string

GoString returns the string representation.

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

func (*OrganizationConfiguration) SetConfigurationType added in v1.48.5 

func (s *OrganizationConfiguration) SetConfigurationType(v string) *OrganizationConfiguration

SetConfigurationType sets the ConfigurationType field's value.

func (*OrganizationConfiguration) SetStatus added in v1.48.5 

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

SetStatus sets the Status field's value.

func (*OrganizationConfiguration) SetStatusMessage added in v1.48.5 

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

SetStatusMessage sets the StatusMessage field's value.

func (OrganizationConfiguration) String added in v1.48.5 

func (s OrganizationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *Page) SetLineRange(v *Range) *Page

SetLineRange sets the LineRange field's value.

func (*Page) SetOffsetRange added in v1.38.0 

func (s *Page) SetOffsetRange(v *Range) *Page

SetOffsetRange sets the OffsetRange field's value.

func (*Page) SetPageNumber added in v1.38.0 

func (s *Page) SetPageNumber(v int64) *Page

SetPageNumber sets the PageNumber field's value.

func (Page) String added in v1.38.0 

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 ParameterConfiguration added in v1.48.4 

type ParameterConfiguration struct {

	// The current value of a control parameter.
	Value *ParameterValue `type:"structure"`

	// Identifies whether a control parameter uses a custom user-defined value or
	// subscribes to the default Security Hub behavior.
	//
	// When ValueType is set equal to DEFAULT, the default behavior can be a specific
	// Security Hub default value, or the default behavior can be to ignore a specific
	// parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided
	// input for the Value field.
	//
	// When ValueType is set equal to CUSTOM, the Value field can't be empty.
	//
	// ValueType is a required field
	ValueType *string `type:"string" required:"true" enum:"ParameterValueType"`
	// contains filtered or unexported fields
}

An object that provides the current value of a security control parameter and identifies whether it has been customized.

func (ParameterConfiguration) GoString added in v1.48.4 

func (s ParameterConfiguration) GoString() string

GoString returns the string representation.

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

func (*ParameterConfiguration) SetValue added in v1.48.4 

func (s *ParameterConfiguration) SetValue(v *ParameterValue) *ParameterConfiguration

SetValue sets the Value field's value.

func (*ParameterConfiguration) SetValueType added in v1.48.4 

func (s *ParameterConfiguration) SetValueType(v string) *ParameterConfiguration

SetValueType sets the ValueType field's value.

func (ParameterConfiguration) String added in v1.48.4 

func (s ParameterConfiguration) String() string

String returns the string representation.

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

func (*ParameterConfiguration) Validate added in v1.48.4 

func (s *ParameterConfiguration) Validate() error

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

type ParameterDefinition added in v1.48.4 

type ParameterDefinition struct {

	// The options for customizing a control parameter. Customization options vary
	// based on the data type of the parameter.
	//
	// ConfigurationOptions is a required field
	ConfigurationOptions *ConfigurationOptions `type:"structure" required:"true"`

	// Description of a control parameter.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that describes a security control parameter and the options for customizing it.

func (ParameterDefinition) GoString added in v1.48.4 

func (s ParameterDefinition) GoString() string

GoString returns the string representation.

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

func (*ParameterDefinition) SetConfigurationOptions added in v1.48.4 

func (s *ParameterDefinition) SetConfigurationOptions(v *ConfigurationOptions) *ParameterDefinition

SetConfigurationOptions sets the ConfigurationOptions field's value.

func (*ParameterDefinition) SetDescription added in v1.48.4 

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

SetDescription sets the Description field's value.

func (ParameterDefinition) String added in v1.48.4 

func (s ParameterDefinition) String() string

String returns the string representation.

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

type ParameterValue added in v1.48.4 

type ParameterValue struct {

	// A control parameter that is a boolean.
	Boolean *bool `type:"boolean"`

	// A control parameter that is a double.
	Double *float64 `type:"double"`

	// A control parameter that is an enum.
	Enum *string `type:"string"`

	// A control parameter that is a list of enums.
	EnumList []*string `type:"list"`

	// A control parameter that is an integer.
	Integer *int64 `type:"integer"`

	// A control parameter that is a list of integers.
	IntegerList []*int64 `type:"list"`

	// A control parameter that is a list of strings.
	StringList []*string `type:"list"`

	// A control parameter that is a string.
	String_ *string `locationName:"String" type:"string"`
	// contains filtered or unexported fields
}

An object that includes the data type of a security control parameter and its current value.

func (ParameterValue) GoString added in v1.48.4 

func (s ParameterValue) GoString() string

GoString returns the string representation.

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

func (*ParameterValue) SetBoolean added in v1.48.4 

func (s *ParameterValue) SetBoolean(v bool) *ParameterValue

SetBoolean sets the Boolean field's value.

func (*ParameterValue) SetDouble added in v1.48.4 

func (s *ParameterValue) SetDouble(v float64) *ParameterValue

SetDouble sets the Double field's value.

func (*ParameterValue) SetEnum added in v1.48.4 

func (s *ParameterValue) SetEnum(v string) *ParameterValue

SetEnum sets the Enum field's value.

func (*ParameterValue) SetEnumList added in v1.48.4 

func (s *ParameterValue) SetEnumList(v []*string) *ParameterValue

SetEnumList sets the EnumList field's value.

func (*ParameterValue) SetInteger added in v1.48.4 

func (s *ParameterValue) SetInteger(v int64) *ParameterValue

SetInteger sets the Integer field's value.

func (*ParameterValue) SetIntegerList added in v1.48.4 

func (s *ParameterValue) SetIntegerList(v []*int64) *ParameterValue

SetIntegerList sets the IntegerList field's value.

func (*ParameterValue) SetStringList added in v1.48.4 

func (s *ParameterValue) SetStringList(v []*string) *ParameterValue

SetStringList sets the StringList field's value.

func (*ParameterValue) SetString_ added in v1.48.4 

func (s *ParameterValue) SetString_(v string) *ParameterValue

SetString_ sets the String_ field's value.

func (ParameterValue) String added in v1.48.4 

func (s ParameterValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.34.15 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	OperationEndTime *string `type:"string"`

	// Indicates when the operation started.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.34.15 

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 added in v1.34.15 

func (s *PatchSummary) SetFailedCount(v int64) *PatchSummary

SetFailedCount sets the FailedCount field's value.

func (*PatchSummary) SetId added in v1.34.15 

func (s *PatchSummary) SetId(v string) *PatchSummary

SetId sets the Id field's value.

func (*PatchSummary) SetInstalledCount added in v1.34.15 

func (s *PatchSummary) SetInstalledCount(v int64) *PatchSummary

SetInstalledCount sets the InstalledCount field's value.

func (*PatchSummary) SetInstalledOtherCount added in v1.34.15 

func (s *PatchSummary) SetInstalledOtherCount(v int64) *PatchSummary

SetInstalledOtherCount sets the InstalledOtherCount field's value.

func (*PatchSummary) SetInstalledPendingReboot added in v1.34.15 

func (s *PatchSummary) SetInstalledPendingReboot(v int64) *PatchSummary

SetInstalledPendingReboot sets the InstalledPendingReboot field's value.

func (*PatchSummary) SetInstalledRejectedCount added in v1.34.15 

func (s *PatchSummary) SetInstalledRejectedCount(v int64) *PatchSummary

SetInstalledRejectedCount sets the InstalledRejectedCount field's value.

func (*PatchSummary) SetMissingCount added in v1.34.15 

func (s *PatchSummary) SetMissingCount(v int64) *PatchSummary

SetMissingCount sets the MissingCount field's value.

func (*PatchSummary) SetOperation added in v1.34.15 

func (s *PatchSummary) SetOperation(v string) *PatchSummary

SetOperation sets the Operation field's value.

func (*PatchSummary) SetOperationEndTime added in v1.34.15 

func (s *PatchSummary) SetOperationEndTime(v string) *PatchSummary

SetOperationEndTime sets the OperationEndTime field's value.

func (*PatchSummary) SetOperationStartTime added in v1.34.15 

func (s *PatchSummary) SetOperationStartTime(v string) *PatchSummary

SetOperationStartTime sets the OperationStartTime field's value.

func (*PatchSummary) SetRebootOption added in v1.34.15 

func (s *PatchSummary) SetRebootOption(v string) *PatchSummary

SetRebootOption sets the RebootOption field's value.

func (PatchSummary) String added in v1.34.15 

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 added in v1.34.15 

func (s *PatchSummary) Validate() error

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

type Policy added in v1.48.5 

type Policy struct {

	// The Amazon Web Service that the configuration policy applies to.
	SecurityHub *SecurityHubPolicy `type:"structure"`
	// contains filtered or unexported fields
}

An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).

func (Policy) GoString added in v1.48.5 

func (s Policy) GoString() string

GoString returns the string representation.

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

func (*Policy) SetSecurityHub added in v1.48.5 

func (s *Policy) SetSecurityHub(v *SecurityHubPolicy) *Policy

SetSecurityHub sets the SecurityHub field's value.

func (Policy) String added in v1.48.5 

func (s Policy) String() string

String returns the string representation.

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

func (*Policy) Validate added in v1.48.5 

func (s *Policy) Validate() error

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

type PortProbeAction added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *PortProbeAction) SetBlocked(v bool) *PortProbeAction

SetBlocked sets the Blocked field's value.

func (*PortProbeAction) SetPortProbeDetails added in v1.36.30 

func (s *PortProbeAction) SetPortProbeDetails(v []*PortProbeDetail) *PortProbeAction

SetPortProbeDetails sets the PortProbeDetails field's value.

func (PortProbeAction) String added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

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 added in v1.36.30 

func (s *PortProbeDetail) SetLocalIpDetails(v *ActionLocalIpDetails) *PortProbeDetail

SetLocalIpDetails sets the LocalIpDetails field's value.

func (*PortProbeDetail) SetLocalPortDetails added in v1.36.30 

func (s *PortProbeDetail) SetLocalPortDetails(v *ActionLocalPortDetails) *PortProbeDetail

SetLocalPortDetails sets the LocalPortDetails field's value.

func (*PortProbeDetail) SetRemoteIpDetails added in v1.36.30 

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

SetRemoteIpDetails sets the RemoteIpDetails field's value.

func (PortProbeDetail) String added in v1.36.30 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *PortRange) SetBegin(v int64) *PortRange

SetBegin sets the Begin field's value.

func (*PortRange) SetEnd added in v1.33.0 

func (s *PortRange) SetEnd(v int64) *PortRange

SetEnd sets the End field's value.

func (PortRange) String added in v1.33.0 

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 added in v1.38.31 

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 added in v1.38.31 

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 added in v1.38.31 

func (s *PortRangeFromTo) SetFrom(v int64) *PortRangeFromTo

SetFrom sets the From field's value.

func (*PortRangeFromTo) SetTo added in v1.38.31 

func (s *PortRangeFromTo) SetTo(v int64) *PortRangeFromTo

SetTo sets the To field's value.

func (PortRangeFromTo) String added in v1.38.31 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 added in v1.19.40 

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 added in v1.19.40 

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 added in v1.19.40 

func (s *Product) SetActivationUrl(v string) *Product

SetActivationUrl sets the ActivationUrl field's value.

func (*Product) SetCategories added in v1.19.40 

func (s *Product) SetCategories(v []*string) *Product

SetCategories sets the Categories field's value.

func (*Product) SetCompanyName added in v1.19.40 

func (s *Product) SetCompanyName(v string) *Product

SetCompanyName sets the CompanyName field's value.

func (*Product) SetDescription added in v1.19.40 

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

SetDescription sets the Description field's value.

func (*Product) SetIntegrationTypes added in v1.29.11 

func (s *Product) SetIntegrationTypes(v []*string) *Product

SetIntegrationTypes sets the IntegrationTypes field's value.

func (*Product) SetMarketplaceUrl added in v1.19.40 

func (s *Product) SetMarketplaceUrl(v string) *Product

SetMarketplaceUrl sets the MarketplaceUrl field's value.

func (*Product) SetProductArn added in v1.19.40 

func (s *Product) SetProductArn(v string) *Product

SetProductArn sets the ProductArn field's value.

func (*Product) SetProductName added in v1.19.40 

func (s *Product) SetProductName(v string) *Product

SetProductName sets the ProductName field's value.

func (*Product) SetProductSubscriptionResourcePolicy added in v1.19.40 

func (s *Product) SetProductSubscriptionResourcePolicy(v string) *Product

SetProductSubscriptionResourcePolicy sets the ProductSubscriptionResourcePolicy field's value.

func (Product) String added in v1.19.40 

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.44.230 

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.44.230 

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.44.230 

func (s *PropagatingVgwSetDetails) SetGatewayId(v string) *PropagatingVgwSetDetails

SetGatewayId sets the GatewayId field's value.

func (PropagatingVgwSetDetails) String added in v1.44.230 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *Range) SetEnd(v int64) *Range

SetEnd sets the End field's value.

func (*Range) SetStart added in v1.38.0 

func (s *Range) SetStart(v int64) *Range

SetStart sets the Start field's value.

func (*Range) SetStartColumn added in v1.38.0 

func (s *Range) SetStartColumn(v int64) *Range

SetStartColumn sets the StartColumn field's value.

func (Range) String added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *Record) SetJsonPath(v string) *Record

SetJsonPath sets the JsonPath field's value.

func (*Record) SetRecordIndex added in v1.38.0 

func (s *Record) SetRecordIndex(v int64) *Record

SetRecordIndex sets the RecordIndex field's value.

func (Record) String added in v1.38.0 

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 {

	// The Amazon Resource Name (ARN) of the application that is related to a finding.
	ApplicationArn *string `type:"string"`

	// The name of the application that is related to a finding.
	ApplicationName *string `type:"string"`

	// 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) SetApplicationArn added in v1.48.5 

func (s *Resource) SetApplicationArn(v string) *Resource

SetApplicationArn sets the ApplicationArn field's value.

func (*Resource) SetApplicationName added in v1.48.5 

func (s *Resource) SetApplicationName(v string) *Resource

SetApplicationName sets the ApplicationName field's value.

func (*Resource) SetDataClassification added in v1.38.0 

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 added in v1.35.0 

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 added in v1.28.0 

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 added in v1.28.0 

func (s *ResourceConflictException) Code() string

Code returns the exception type name.

func (*ResourceConflictException) Error added in v1.28.0 

func (s *ResourceConflictException) Error() string

func (ResourceConflictException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *ResourceConflictException) Message() string

Message returns the exception's message.

func (*ResourceConflictException) OrigErr added in v1.28.0 

func (s *ResourceConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceConflictException) RequestID added in v1.28.0 

func (s *ResourceConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceConflictException) StatusCode added in v1.28.0 

func (s *ResourceConflictException) StatusCode() int

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

func (ResourceConflictException) String added in v1.28.0 

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"`

	// Provides details about an Database Migration Service (DMS) endpoint. An endpoint
	// provides connection, data store type, and location information about your
	// data store.
	AwsDmsEndpoint *AwsDmsEndpointDetails `type:"structure"`

	// Provides details about an DMS replication instance. DMS uses a replication
	// instance to connect to your source data store, read the source data, and
	// format the data for consumption by the target data store.
	AwsDmsReplicationInstance *AwsDmsReplicationInstanceDetails `type:"structure"`

	// Provides details about an DMS replication task. A replication task moves
	// a set of data from the source endpoint to the target endpoint.
	AwsDmsReplicationTask *AwsDmsReplicationTaskDetails `type:"structure"`

	// Details about a DynamoDB table.
	AwsDynamoDbTable *AwsDynamoDbTableDetails `type:"structure"`

	// Provides details about an Client VPN endpoint. A Client VPN endpoint is the
	// resource that you create and configure to enable and manage client VPN sessions.
	// It's the termination point for all client VPN sessions.
	AwsEc2ClientVpnEndpoint *AwsEc2ClientVpnEndpointDetails `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 EventBridge global endpoint. The endpoint
	// can improve your application’s availability by making it Regional-fault
	// tolerant.
	AwsEventsEndpoint *AwsEventsEndpointDetails `type:"structure"`

	// Provides details about Amazon EventBridge event bus for an endpoint. An event
	// bus is a router that receives events and delivers them to zero or more destinations,
	// or targets.
	AwsEventsEventbus *AwsEventsEventbusDetails `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"`

	// Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon
	// MSK) cluster.
	AwsMskCluster *AwsMskClusterDetails `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"`

	// Provides details about an Amazon Route 53 hosted zone, including the four
	// name servers assigned to the hosted zone. A hosted zone represents a collection
	// of records that can be managed together, belonging to a single parent domain
	// name.
	AwsRoute53HostedZone *AwsRoute53HostedZoneDetails `type:"structure"`

	// Provides details about an Amazon Simple Storage Service (Amazon S3) access
	// point. S3 access points are named network endpoints that are attached to
	// S3 buckets that you can use to perform S3 object operations.
	AwsS3AccessPoint *AwsS3AccessPointDetails `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.44.272 

func (s *ResourceDetails) SetAwsAmazonMqBroker(v *AwsAmazonMqBrokerDetails) *ResourceDetails

SetAwsAmazonMqBroker sets the AwsAmazonMqBroker field's value.

func (*ResourceDetails) SetAwsApiGatewayRestApi added in v1.35.0 

func (s *ResourceDetails) SetAwsApiGatewayRestApi(v *AwsApiGatewayRestApiDetails) *ResourceDetails

SetAwsApiGatewayRestApi sets the AwsApiGatewayRestApi field's value.

func (*ResourceDetails) SetAwsApiGatewayStage added in v1.35.0 

func (s *ResourceDetails) SetAwsApiGatewayStage(v *AwsApiGatewayStageDetails) *ResourceDetails

SetAwsApiGatewayStage sets the AwsApiGatewayStage field's value.

func (*ResourceDetails) SetAwsApiGatewayV2Api added in v1.35.0 

func (s *ResourceDetails) SetAwsApiGatewayV2Api(v *AwsApiGatewayV2ApiDetails) *ResourceDetails

SetAwsApiGatewayV2Api sets the AwsApiGatewayV2Api field's value.

func (*ResourceDetails) SetAwsApiGatewayV2Stage added in v1.35.0 

func (s *ResourceDetails) SetAwsApiGatewayV2Stage(v *AwsApiGatewayV2StageDetails) *ResourceDetails

SetAwsApiGatewayV2Stage sets the AwsApiGatewayV2Stage field's value.

func (*ResourceDetails) SetAwsAppSyncGraphQlApi added in v1.44.272 

func (s *ResourceDetails) SetAwsAppSyncGraphQlApi(v *AwsAppSyncGraphQlApiDetails) *ResourceDetails

SetAwsAppSyncGraphQlApi sets the AwsAppSyncGraphQlApi field's value.

func (*ResourceDetails) SetAwsAthenaWorkGroup added in v1.44.308 

func (s *ResourceDetails) SetAwsAthenaWorkGroup(v *AwsAthenaWorkGroupDetails) *ResourceDetails

SetAwsAthenaWorkGroup sets the AwsAthenaWorkGroup field's value.

func (*ResourceDetails) SetAwsAutoScalingAutoScalingGroup added in v1.33.0 

func (s *ResourceDetails) SetAwsAutoScalingAutoScalingGroup(v *AwsAutoScalingAutoScalingGroupDetails) *ResourceDetails

SetAwsAutoScalingAutoScalingGroup sets the AwsAutoScalingAutoScalingGroup field's value.

func (*ResourceDetails) SetAwsAutoScalingLaunchConfiguration added in v1.40.36 

func (s *ResourceDetails) SetAwsAutoScalingLaunchConfiguration(v *AwsAutoScalingLaunchConfigurationDetails) *ResourceDetails

SetAwsAutoScalingLaunchConfiguration sets the AwsAutoScalingLaunchConfiguration field's value.

func (*ResourceDetails) SetAwsBackupBackupPlan added in v1.44.82 

func (s *ResourceDetails) SetAwsBackupBackupPlan(v *AwsBackupBackupPlanDetails) *ResourceDetails

SetAwsBackupBackupPlan sets the AwsBackupBackupPlan field's value.

func (*ResourceDetails) SetAwsBackupBackupVault added in v1.44.82 

func (s *ResourceDetails) SetAwsBackupBackupVault(v *AwsBackupBackupVaultDetails) *ResourceDetails

SetAwsBackupBackupVault sets the AwsBackupBackupVault field's value.

func (*ResourceDetails) SetAwsBackupRecoveryPoint added in v1.44.82 

func (s *ResourceDetails) SetAwsBackupRecoveryPoint(v *AwsBackupRecoveryPointDetails) *ResourceDetails

SetAwsBackupRecoveryPoint sets the AwsBackupRecoveryPoint field's value.

func (*ResourceDetails) SetAwsCertificateManagerCertificate added in v1.35.0 

func (s *ResourceDetails) SetAwsCertificateManagerCertificate(v *AwsCertificateManagerCertificateDetails) *ResourceDetails

SetAwsCertificateManagerCertificate sets the AwsCertificateManagerCertificate field's value.

func (*ResourceDetails) SetAwsCloudFormationStack added in v1.44.36 

func (s *ResourceDetails) SetAwsCloudFormationStack(v *AwsCloudFormationStackDetails) *ResourceDetails

SetAwsCloudFormationStack sets the AwsCloudFormationStack field's value.

func (*ResourceDetails) SetAwsCloudFrontDistribution added in v1.26.7 

func (s *ResourceDetails) SetAwsCloudFrontDistribution(v *AwsCloudFrontDistributionDetails) *ResourceDetails

SetAwsCloudFrontDistribution sets the AwsCloudFrontDistribution field's value.

func (*ResourceDetails) SetAwsCloudTrailTrail added in v1.35.0 

func (s *ResourceDetails) SetAwsCloudTrailTrail(v *AwsCloudTrailTrailDetails) *ResourceDetails

SetAwsCloudTrailTrail sets the AwsCloudTrailTrail field's value.

func (*ResourceDetails) SetAwsCloudWatchAlarm added in v1.44.36 

func (s *ResourceDetails) SetAwsCloudWatchAlarm(v *AwsCloudWatchAlarmDetails) *ResourceDetails

SetAwsCloudWatchAlarm sets the AwsCloudWatchAlarm field's value.

func (*ResourceDetails) SetAwsCodeBuildProject added in v1.28.11 

func (s *ResourceDetails) SetAwsCodeBuildProject(v *AwsCodeBuildProjectDetails) *ResourceDetails

SetAwsCodeBuildProject sets the AwsCodeBuildProject field's value.

func (*ResourceDetails) SetAwsDmsEndpoint added in v1.45.23 

func (s *ResourceDetails) SetAwsDmsEndpoint(v *AwsDmsEndpointDetails) *ResourceDetails

SetAwsDmsEndpoint sets the AwsDmsEndpoint field's value.

func (*ResourceDetails) SetAwsDmsReplicationInstance added in v1.45.23 

func (s *ResourceDetails) SetAwsDmsReplicationInstance(v *AwsDmsReplicationInstanceDetails) *ResourceDetails

SetAwsDmsReplicationInstance sets the AwsDmsReplicationInstance field's value.

func (*ResourceDetails) SetAwsDmsReplicationTask added in v1.45.23 

func (s *ResourceDetails) SetAwsDmsReplicationTask(v *AwsDmsReplicationTaskDetails) *ResourceDetails

SetAwsDmsReplicationTask sets the AwsDmsReplicationTask field's value.

func (*ResourceDetails) SetAwsDynamoDbTable added in v1.34.7 

func (s *ResourceDetails) SetAwsDynamoDbTable(v *AwsDynamoDbTableDetails) *ResourceDetails

SetAwsDynamoDbTable sets the AwsDynamoDbTable field's value.

func (*ResourceDetails) SetAwsEc2ClientVpnEndpoint added in v1.49.0 

func (s *ResourceDetails) SetAwsEc2ClientVpnEndpoint(v *AwsEc2ClientVpnEndpointDetails) *ResourceDetails

SetAwsEc2ClientVpnEndpoint sets the AwsEc2ClientVpnEndpoint field's value.

func (*ResourceDetails) SetAwsEc2Eip added in v1.34.7 

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.44.161 

func (s *ResourceDetails) SetAwsEc2LaunchTemplate(v *AwsEc2LaunchTemplateDetails) *ResourceDetails

SetAwsEc2LaunchTemplate sets the AwsEc2LaunchTemplate field's value.

func (*ResourceDetails) SetAwsEc2NetworkAcl added in v1.38.31 

func (s *ResourceDetails) SetAwsEc2NetworkAcl(v *AwsEc2NetworkAclDetails) *ResourceDetails

SetAwsEc2NetworkAcl sets the AwsEc2NetworkAcl field's value.

func (*ResourceDetails) SetAwsEc2NetworkInterface added in v1.28.11 

func (s *ResourceDetails) SetAwsEc2NetworkInterface(v *AwsEc2NetworkInterfaceDetails) *ResourceDetails

SetAwsEc2NetworkInterface sets the AwsEc2NetworkInterface field's value.

func (*ResourceDetails) SetAwsEc2RouteTable added in v1.44.230 

func (s *ResourceDetails) SetAwsEc2RouteTable(v *AwsEc2RouteTableDetails) *ResourceDetails

SetAwsEc2RouteTable sets the AwsEc2RouteTable field's value.

func (*ResourceDetails) SetAwsEc2SecurityGroup added in v1.28.11 

func (s *ResourceDetails) SetAwsEc2SecurityGroup(v *AwsEc2SecurityGroupDetails) *ResourceDetails

SetAwsEc2SecurityGroup sets the AwsEc2SecurityGroup field's value.

func (*ResourceDetails) SetAwsEc2Subnet added in v1.38.31 

func (s *ResourceDetails) SetAwsEc2Subnet(v *AwsEc2SubnetDetails) *ResourceDetails

SetAwsEc2Subnet sets the AwsEc2Subnet field's value.

func (*ResourceDetails) SetAwsEc2TransitGateway added in v1.44.36 

func (s *ResourceDetails) SetAwsEc2TransitGateway(v *AwsEc2TransitGatewayDetails) *ResourceDetails

SetAwsEc2TransitGateway sets the AwsEc2TransitGateway field's value.

func (*ResourceDetails) SetAwsEc2Volume added in v1.33.0 

func (s *ResourceDetails) SetAwsEc2Volume(v *AwsEc2VolumeDetails) *ResourceDetails

SetAwsEc2Volume sets the AwsEc2Volume field's value.

func (*ResourceDetails) SetAwsEc2Vpc added in v1.33.0 

func (s *ResourceDetails) SetAwsEc2Vpc(v *AwsEc2VpcDetails) *ResourceDetails

SetAwsEc2Vpc sets the AwsEc2Vpc field's value.

func (*ResourceDetails) SetAwsEc2VpcEndpointService added in v1.40.59 

func (s *ResourceDetails) SetAwsEc2VpcEndpointService(v *AwsEc2VpcEndpointServiceDetails) *ResourceDetails

SetAwsEc2VpcEndpointService sets the AwsEc2VpcEndpointService field's value.

func (*ResourceDetails) SetAwsEc2VpcPeeringConnection added in v1.44.36 

func (s *ResourceDetails) SetAwsEc2VpcPeeringConnection(v *AwsEc2VpcPeeringConnectionDetails) *ResourceDetails

SetAwsEc2VpcPeeringConnection sets the AwsEc2VpcPeeringConnection field's value.

func (*ResourceDetails) SetAwsEc2VpnConnection added in v1.40.36 

func (s *ResourceDetails) SetAwsEc2VpnConnection(v *AwsEc2VpnConnectionDetails) *ResourceDetails

SetAwsEc2VpnConnection sets the AwsEc2VpnConnection field's value.

func (*ResourceDetails) SetAwsEcrContainerImage added in v1.40.36 

func (s *ResourceDetails) SetAwsEcrContainerImage(v *AwsEcrContainerImageDetails) *ResourceDetails

SetAwsEcrContainerImage sets the AwsEcrContainerImage field's value.

func (*ResourceDetails) SetAwsEcrRepository added in v1.40.59 

func (s *ResourceDetails) SetAwsEcrRepository(v *AwsEcrRepositoryDetails) *ResourceDetails

SetAwsEcrRepository sets the AwsEcrRepository field's value.

func (*ResourceDetails) SetAwsEcsCluster added in v1.38.67 

func (s *ResourceDetails) SetAwsEcsCluster(v *AwsEcsClusterDetails) *ResourceDetails

SetAwsEcsCluster sets the AwsEcsCluster field's value.

func (*ResourceDetails) SetAwsEcsContainer added in v1.44.36 

func (s *ResourceDetails) SetAwsEcsContainer(v *AwsEcsContainerDetails) *ResourceDetails

SetAwsEcsContainer sets the AwsEcsContainer field's value.

func (*ResourceDetails) SetAwsEcsService added in v1.40.7 

func (s *ResourceDetails) SetAwsEcsService(v *AwsEcsServiceDetails) *ResourceDetails

SetAwsEcsService sets the AwsEcsService field's value.

func (*ResourceDetails) SetAwsEcsTask added in v1.44.36 

func (s *ResourceDetails) SetAwsEcsTask(v *AwsEcsTaskDetails) *ResourceDetails

SetAwsEcsTask sets the AwsEcsTask field's value.

func (*ResourceDetails) SetAwsEcsTaskDefinition added in v1.38.67 

func (s *ResourceDetails) SetAwsEcsTaskDefinition(v *AwsEcsTaskDefinitionDetails) *ResourceDetails

SetAwsEcsTaskDefinition sets the AwsEcsTaskDefinition field's value.

func (*ResourceDetails) SetAwsEfsAccessPoint added in v1.44.36 

func (s *ResourceDetails) SetAwsEfsAccessPoint(v *AwsEfsAccessPointDetails) *ResourceDetails

SetAwsEfsAccessPoint sets the AwsEfsAccessPoint field's value.

func (*ResourceDetails) SetAwsEksCluster added in v1.40.59 

func (s *ResourceDetails) SetAwsEksCluster(v *AwsEksClusterDetails) *ResourceDetails

SetAwsEksCluster sets the AwsEksCluster field's value.

func (*ResourceDetails) SetAwsElasticBeanstalkEnvironment added in v1.38.31 

func (s *ResourceDetails) SetAwsElasticBeanstalkEnvironment(v *AwsElasticBeanstalkEnvironmentDetails) *ResourceDetails

SetAwsElasticBeanstalkEnvironment sets the AwsElasticBeanstalkEnvironment field's value.

func (*ResourceDetails) SetAwsElasticsearchDomain added in v1.28.11 

func (s *ResourceDetails) SetAwsElasticsearchDomain(v *AwsElasticsearchDomainDetails) *ResourceDetails

SetAwsElasticsearchDomain sets the AwsElasticsearchDomain field's value.

func (*ResourceDetails) SetAwsElbLoadBalancer added in v1.35.0 

func (s *ResourceDetails) SetAwsElbLoadBalancer(v *AwsElbLoadBalancerDetails) *ResourceDetails

SetAwsElbLoadBalancer sets the AwsElbLoadBalancer field's value.

func (*ResourceDetails) SetAwsElbv2LoadBalancer added in v1.26.7 

func (s *ResourceDetails) SetAwsElbv2LoadBalancer(v *AwsElbv2LoadBalancerDetails) *ResourceDetails

SetAwsElbv2LoadBalancer sets the AwsElbv2LoadBalancer field's value.

func (*ResourceDetails) SetAwsEventSchemasRegistry added in v1.44.272 

func (s *ResourceDetails) SetAwsEventSchemasRegistry(v *AwsEventSchemasRegistryDetails) *ResourceDetails

SetAwsEventSchemasRegistry sets the AwsEventSchemasRegistry field's value.

func (*ResourceDetails) SetAwsEventsEndpoint added in v1.45.23 

func (s *ResourceDetails) SetAwsEventsEndpoint(v *AwsEventsEndpointDetails) *ResourceDetails

SetAwsEventsEndpoint sets the AwsEventsEndpoint field's value.

func (*ResourceDetails) SetAwsEventsEventbus added in v1.45.23 

func (s *ResourceDetails) SetAwsEventsEventbus(v *AwsEventsEventbusDetails) *ResourceDetails

SetAwsEventsEventbus sets the AwsEventsEventbus field's value.

func (*ResourceDetails) SetAwsGuardDutyDetector added in v1.44.272 

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 added in v1.35.0 

func (s *ResourceDetails) SetAwsIamGroup(v *AwsIamGroupDetails) *ResourceDetails

SetAwsIamGroup sets the AwsIamGroup field's value.

func (*ResourceDetails) SetAwsIamPolicy added in v1.34.7 

func (s *ResourceDetails) SetAwsIamPolicy(v *AwsIamPolicyDetails) *ResourceDetails

SetAwsIamPolicy sets the AwsIamPolicy field's value.

func (*ResourceDetails) SetAwsIamRole added in v1.26.7 

func (s *ResourceDetails) SetAwsIamRole(v *AwsIamRoleDetails) *ResourceDetails

SetAwsIamRole sets the AwsIamRole field's value.

func (*ResourceDetails) SetAwsIamUser added in v1.34.7 

func (s *ResourceDetails) SetAwsIamUser(v *AwsIamUserDetails) *ResourceDetails

SetAwsIamUser sets the AwsIamUser field's value.

func (*ResourceDetails) SetAwsKinesisStream added in v1.44.36 

func (s *ResourceDetails) SetAwsKinesisStream(v *AwsKinesisStreamDetails) *ResourceDetails

SetAwsKinesisStream sets the AwsKinesisStream field's value.

func (*ResourceDetails) SetAwsKmsKey added in v1.26.7 

func (s *ResourceDetails) SetAwsKmsKey(v *AwsKmsKeyDetails) *ResourceDetails

SetAwsKmsKey sets the AwsKmsKey field's value.

func (*ResourceDetails) SetAwsLambdaFunction added in v1.26.7 

func (s *ResourceDetails) SetAwsLambdaFunction(v *AwsLambdaFunctionDetails) *ResourceDetails

SetAwsLambdaFunction sets the AwsLambdaFunction field's value.

func (*ResourceDetails) SetAwsLambdaLayerVersion added in v1.28.11 

func (s *ResourceDetails) SetAwsLambdaLayerVersion(v *AwsLambdaLayerVersionDetails) *ResourceDetails

SetAwsLambdaLayerVersion sets the AwsLambdaLayerVersion field's value.

func (*ResourceDetails) SetAwsMskCluster added in v1.45.23 

func (s *ResourceDetails) SetAwsMskCluster(v *AwsMskClusterDetails) *ResourceDetails

SetAwsMskCluster sets the AwsMskCluster field's value.

func (*ResourceDetails) SetAwsNetworkFirewallFirewall added in v1.42.24 

func (s *ResourceDetails) SetAwsNetworkFirewallFirewall(v *AwsNetworkFirewallFirewallDetails) *ResourceDetails

SetAwsNetworkFirewallFirewall sets the AwsNetworkFirewallFirewall field's value.

func (*ResourceDetails) SetAwsNetworkFirewallFirewallPolicy added in v1.42.24 

func (s *ResourceDetails) SetAwsNetworkFirewallFirewallPolicy(v *AwsNetworkFirewallFirewallPolicyDetails) *ResourceDetails

SetAwsNetworkFirewallFirewallPolicy sets the AwsNetworkFirewallFirewallPolicy field's value.

func (*ResourceDetails) SetAwsNetworkFirewallRuleGroup added in v1.42.24 

func (s *ResourceDetails) SetAwsNetworkFirewallRuleGroup(v *AwsNetworkFirewallRuleGroupDetails) *ResourceDetails

SetAwsNetworkFirewallRuleGroup sets the AwsNetworkFirewallRuleGroup field's value.

func (*ResourceDetails) SetAwsOpenSearchServiceDomain added in v1.40.59 

func (s *ResourceDetails) SetAwsOpenSearchServiceDomain(v *AwsOpenSearchServiceDomainDetails) *ResourceDetails

SetAwsOpenSearchServiceDomain sets the AwsOpenSearchServiceDomain field's value.

func (*ResourceDetails) SetAwsRdsDbCluster added in v1.34.7 

func (s *ResourceDetails) SetAwsRdsDbCluster(v *AwsRdsDbClusterDetails) *ResourceDetails

SetAwsRdsDbCluster sets the AwsRdsDbCluster field's value.

func (*ResourceDetails) SetAwsRdsDbClusterSnapshot added in v1.34.7 

func (s *ResourceDetails) SetAwsRdsDbClusterSnapshot(v *AwsRdsDbClusterSnapshotDetails) *ResourceDetails

SetAwsRdsDbClusterSnapshot sets the AwsRdsDbClusterSnapshot field's value.

func (*ResourceDetails) SetAwsRdsDbInstance added in v1.28.11 

func (s *ResourceDetails) SetAwsRdsDbInstance(v *AwsRdsDbInstanceDetails) *ResourceDetails

SetAwsRdsDbInstance sets the AwsRdsDbInstance field's value.

func (*ResourceDetails) SetAwsRdsDbSecurityGroup added in v1.43.33 

func (s *ResourceDetails) SetAwsRdsDbSecurityGroup(v *AwsRdsDbSecurityGroupDetails) *ResourceDetails

SetAwsRdsDbSecurityGroup sets the AwsRdsDbSecurityGroup field's value.

func (*ResourceDetails) SetAwsRdsDbSnapshot added in v1.34.7 

func (s *ResourceDetails) SetAwsRdsDbSnapshot(v *AwsRdsDbSnapshotDetails) *ResourceDetails

SetAwsRdsDbSnapshot sets the AwsRdsDbSnapshot field's value.

func (*ResourceDetails) SetAwsRdsEventSubscription added in v1.40.7 

func (s *ResourceDetails) SetAwsRdsEventSubscription(v *AwsRdsEventSubscriptionDetails) *ResourceDetails

SetAwsRdsEventSubscription sets the AwsRdsEventSubscription field's value.

func (*ResourceDetails) SetAwsRedshiftCluster added in v1.35.0 

func (s *ResourceDetails) SetAwsRedshiftCluster(v *AwsRedshiftClusterDetails) *ResourceDetails

SetAwsRedshiftCluster sets the AwsRedshiftCluster field's value.

func (*ResourceDetails) SetAwsRoute53HostedZone added in v1.45.23 

func (s *ResourceDetails) SetAwsRoute53HostedZone(v *AwsRoute53HostedZoneDetails) *ResourceDetails

SetAwsRoute53HostedZone sets the AwsRoute53HostedZone field's value.

func (*ResourceDetails) SetAwsS3AccessPoint added in v1.49.0 

func (s *ResourceDetails) SetAwsS3AccessPoint(v *AwsS3AccessPointDetails) *ResourceDetails

SetAwsS3AccessPoint sets the AwsS3AccessPoint field's value.

func (*ResourceDetails) SetAwsS3AccountPublicAccessBlock added in v1.38.0 

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 added in v1.29.23 

func (s *ResourceDetails) SetAwsS3Object(v *AwsS3ObjectDetails) *ResourceDetails

SetAwsS3Object sets the AwsS3Object field's value.

func (*ResourceDetails) SetAwsSageMakerNotebookInstance added in v1.44.161 

func (s *ResourceDetails) SetAwsSageMakerNotebookInstance(v *AwsSageMakerNotebookInstanceDetails) *ResourceDetails

SetAwsSageMakerNotebookInstance sets the AwsSageMakerNotebookInstance field's value.

func (*ResourceDetails) SetAwsSecretsManagerSecret added in v1.34.7 

func (s *ResourceDetails) SetAwsSecretsManagerSecret(v *AwsSecretsManagerSecretDetails) *ResourceDetails

SetAwsSecretsManagerSecret sets the AwsSecretsManagerSecret field's value.

func (*ResourceDetails) SetAwsSnsTopic added in v1.26.7 

func (s *ResourceDetails) SetAwsSnsTopic(v *AwsSnsTopicDetails) *ResourceDetails

SetAwsSnsTopic sets the AwsSnsTopic field's value.

func (*ResourceDetails) SetAwsSqsQueue added in v1.26.7 

func (s *ResourceDetails) SetAwsSqsQueue(v *AwsSqsQueueDetails) *ResourceDetails

SetAwsSqsQueue sets the AwsSqsQueue field's value.

func (*ResourceDetails) SetAwsSsmPatchCompliance added in v1.36.30 

func (s *ResourceDetails) SetAwsSsmPatchCompliance(v *AwsSsmPatchComplianceDetails) *ResourceDetails

SetAwsSsmPatchCompliance sets the AwsSsmPatchCompliance field's value.

func (*ResourceDetails) SetAwsStepFunctionStateMachine added in v1.44.272 

func (s *ResourceDetails) SetAwsStepFunctionStateMachine(v *AwsStepFunctionStateMachineDetails) *ResourceDetails

SetAwsStepFunctionStateMachine sets the AwsStepFunctionStateMachine field's value.

func (*ResourceDetails) SetAwsWafRateBasedRule added in v1.40.59 

func (s *ResourceDetails) SetAwsWafRateBasedRule(v *AwsWafRateBasedRuleDetails) *ResourceDetails

SetAwsWafRateBasedRule sets the AwsWafRateBasedRule field's value.

func (*ResourceDetails) SetAwsWafRegionalRateBasedRule added in v1.40.59 

func (s *ResourceDetails) SetAwsWafRegionalRateBasedRule(v *AwsWafRegionalRateBasedRuleDetails) *ResourceDetails

SetAwsWafRegionalRateBasedRule sets the AwsWafRegionalRateBasedRule field's value.

func (*ResourceDetails) SetAwsWafRegionalRule added in v1.44.36 

func (s *ResourceDetails) SetAwsWafRegionalRule(v *AwsWafRegionalRuleDetails) *ResourceDetails

SetAwsWafRegionalRule sets the AwsWafRegionalRule field's value.

func (*ResourceDetails) SetAwsWafRegionalRuleGroup added in v1.44.36 

func (s *ResourceDetails) SetAwsWafRegionalRuleGroup(v *AwsWafRegionalRuleGroupDetails) *ResourceDetails

SetAwsWafRegionalRuleGroup sets the AwsWafRegionalRuleGroup field's value.

func (*ResourceDetails) SetAwsWafRegionalWebAcl added in v1.44.36 

func (s *ResourceDetails) SetAwsWafRegionalWebAcl(v *AwsWafRegionalWebAclDetails) *ResourceDetails

SetAwsWafRegionalWebAcl sets the AwsWafRegionalWebAcl field's value.

func (*ResourceDetails) SetAwsWafRule added in v1.44.36 

func (s *ResourceDetails) SetAwsWafRule(v *AwsWafRuleDetails) *ResourceDetails

SetAwsWafRule sets the AwsWafRule field's value.

func (*ResourceDetails) SetAwsWafRuleGroup added in v1.44.36 

func (s *ResourceDetails) SetAwsWafRuleGroup(v *AwsWafRuleGroupDetails) *ResourceDetails

SetAwsWafRuleGroup sets the AwsWafRuleGroup field's value.

func (*ResourceDetails) SetAwsWafWebAcl added in v1.28.11 

func (s *ResourceDetails) SetAwsWafWebAcl(v *AwsWafWebAclDetails) *ResourceDetails

SetAwsWafWebAcl sets the AwsWafWebAcl field's value.

func (*ResourceDetails) SetAwsWafv2RuleGroup added in v1.44.161 

func (s *ResourceDetails) SetAwsWafv2RuleGroup(v *AwsWafv2RuleGroupDetails) *ResourceDetails

SetAwsWafv2RuleGroup sets the AwsWafv2RuleGroup field's value.

func (*ResourceDetails) SetAwsWafv2WebAcl added in v1.44.161 

func (s *ResourceDetails) SetAwsWafv2WebAcl(v *AwsWafv2WebAclDetails) *ResourceDetails

SetAwsWafv2WebAcl sets the AwsWafv2WebAcl field's value.

func (*ResourceDetails) SetAwsXrayEncryptionConfig added in v1.40.59 

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 added in v1.26.7 

func (s *ResourceDetails) Validate() error

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

type ResourceInUseException added in v1.48.4 

type ResourceInUseException 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 conflicts with the resource's availability. For example, you tried to update a security control that's currently in the UPDATING state.

func (*ResourceInUseException) Code added in v1.48.4 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.48.4 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.48.4 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

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

func (*ResourceInUseException) Message added in v1.48.4 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.48.4 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.48.4 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.48.4 

func (s *ResourceInUseException) StatusCode() int

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

func (ResourceInUseException) String added in v1.48.4 

func (s ResourceInUseException) String() string

String returns the string representation.

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

type ResourceNotFoundException added in v1.28.0 

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 added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0 

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.44.230 

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.44.230 

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.44.230 

func (s *RouteSetDetails) SetCarrierGatewayId(v string) *RouteSetDetails

SetCarrierGatewayId sets the CarrierGatewayId field's value.

func (*RouteSetDetails) SetCoreNetworkArn added in v1.44.230 

func (s *RouteSetDetails) SetCoreNetworkArn(v string) *RouteSetDetails

SetCoreNetworkArn sets the CoreNetworkArn field's value.

func (*RouteSetDetails) SetDestinationCidrBlock added in v1.44.230 

func (s *RouteSetDetails) SetDestinationCidrBlock(v string) *RouteSetDetails

SetDestinationCidrBlock sets the DestinationCidrBlock field's value.

func (*RouteSetDetails) SetDestinationIpv6CidrBlock added in v1.44.230 

func (s *RouteSetDetails) SetDestinationIpv6CidrBlock(v string) *RouteSetDetails

SetDestinationIpv6CidrBlock sets the DestinationIpv6CidrBlock field's value.

func (*RouteSetDetails) SetDestinationPrefixListId added in v1.44.230 

func (s *RouteSetDetails) SetDestinationPrefixListId(v string) *RouteSetDetails

SetDestinationPrefixListId sets the DestinationPrefixListId field's value.

func (*RouteSetDetails) SetEgressOnlyInternetGatewayId added in v1.44.230 

func (s *RouteSetDetails) SetEgressOnlyInternetGatewayId(v string) *RouteSetDetails

SetEgressOnlyInternetGatewayId sets the EgressOnlyInternetGatewayId field's value.

func (*RouteSetDetails) SetGatewayId added in v1.44.230 

func (s *RouteSetDetails) SetGatewayId(v string) *RouteSetDetails

SetGatewayId sets the GatewayId field's value.

func (*RouteSetDetails) SetInstanceId added in v1.44.230 

func (s *RouteSetDetails) SetInstanceId(v string) *RouteSetDetails

SetInstanceId sets the InstanceId field's value.

func (*RouteSetDetails) SetInstanceOwnerId added in v1.44.230 

func (s *RouteSetDetails) SetInstanceOwnerId(v string) *RouteSetDetails

SetInstanceOwnerId sets the InstanceOwnerId field's value.

func (*RouteSetDetails) SetLocalGatewayId added in v1.44.230 

func (s *RouteSetDetails) SetLocalGatewayId(v string) *RouteSetDetails

SetLocalGatewayId sets the LocalGatewayId field's value.

func (*RouteSetDetails) SetNatGatewayId added in v1.44.230 

func (s *RouteSetDetails) SetNatGatewayId(v string) *RouteSetDetails

SetNatGatewayId sets the NatGatewayId field's value.

func (*RouteSetDetails) SetNetworkInterfaceId added in v1.44.230 

func (s *RouteSetDetails) SetNetworkInterfaceId(v string) *RouteSetDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*RouteSetDetails) SetOrigin added in v1.44.230 

func (s *RouteSetDetails) SetOrigin(v string) *RouteSetDetails

SetOrigin sets the Origin field's value.

func (*RouteSetDetails) SetState added in v1.44.230 

func (s *RouteSetDetails) SetState(v string) *RouteSetDetails

SetState sets the State field's value.

func (*RouteSetDetails) SetTransitGatewayId added in v1.44.230 

func (s *RouteSetDetails) SetTransitGatewayId(v string) *RouteSetDetails

SetTransitGatewayId sets the TransitGatewayId field's value.

func (*RouteSetDetails) SetVpcPeeringConnectionId added in v1.44.230 

func (s *RouteSetDetails) SetVpcPeeringConnectionId(v string) *RouteSetDetails

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (RouteSetDetails) String added in v1.44.230 

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.24 

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.24 

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.24 

func (s *RuleGroupDetails) SetRuleVariables(v *RuleGroupVariables) *RuleGroupDetails

SetRuleVariables sets the RuleVariables field's value.

func (*RuleGroupDetails) SetRulesSource added in v1.42.24 

func (s *RuleGroupDetails) SetRulesSource(v *RuleGroupSource) *RuleGroupDetails

SetRulesSource sets the RulesSource field's value.

func (RuleGroupDetails) String added in v1.42.24 

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.24 

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.24 

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.24 

func (s *RuleGroupSource) SetRulesSourceList(v *RuleGroupSourceListDetails) *RuleGroupSource

SetRulesSourceList sets the RulesSourceList field's value.

func (*RuleGroupSource) SetRulesString added in v1.42.24 

func (s *RuleGroupSource) SetRulesString(v string) *RuleGroupSource

SetRulesString sets the RulesString field's value.

func (*RuleGroupSource) SetStatefulRules added in v1.42.24 

func (s *RuleGroupSource) SetStatefulRules(v []*RuleGroupSourceStatefulRulesDetails) *RuleGroupSource

SetStatefulRules sets the StatefulRules field's value.

func (*RuleGroupSource) SetStatelessRulesAndCustomActions added in v1.42.24 

func (s *RuleGroupSource) SetStatelessRulesAndCustomActions(v *RuleGroupSourceStatelessRulesAndCustomActionsDetails) *RuleGroupSource

SetStatelessRulesAndCustomActions sets the StatelessRulesAndCustomActions field's value.

func (RuleGroupSource) String added in v1.42.24 

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.24 

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.24 

func (s RuleGroupSourceCustomActionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceCustomActionsDetails) SetActionDefinition(v *StatelessCustomActionDefinition) *RuleGroupSourceCustomActionsDetails

SetActionDefinition sets the ActionDefinition field's value.

func (*RuleGroupSourceCustomActionsDetails) SetActionName added in v1.42.24 

func (s *RuleGroupSourceCustomActionsDetails) SetActionName(v string) *RuleGroupSourceCustomActionsDetails

SetActionName sets the ActionName field's value.

func (RuleGroupSourceCustomActionsDetails) String added in v1.42.24 

func (s RuleGroupSourceCustomActionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

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.24 

func (s *RuleGroupSourceListDetails) SetGeneratedRulesType(v string) *RuleGroupSourceListDetails

SetGeneratedRulesType sets the GeneratedRulesType field's value.

func (*RuleGroupSourceListDetails) SetTargetTypes added in v1.42.24 

func (s *RuleGroupSourceListDetails) SetTargetTypes(v []*string) *RuleGroupSourceListDetails

SetTargetTypes sets the TargetTypes field's value.

func (*RuleGroupSourceListDetails) SetTargets added in v1.42.24 

func (s *RuleGroupSourceListDetails) SetTargets(v []*string) *RuleGroupSourceListDetails

SetTargets sets the Targets field's value.

func (RuleGroupSourceListDetails) String added in v1.42.24 

func (s RuleGroupSourceListDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatefulRulesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatefulRulesDetails) SetAction(v string) *RuleGroupSourceStatefulRulesDetails

SetAction sets the Action field's value.

func (*RuleGroupSourceStatefulRulesDetails) SetHeader added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesDetails) SetHeader(v *RuleGroupSourceStatefulRulesHeaderDetails) *RuleGroupSourceStatefulRulesDetails

SetHeader sets the Header field's value.

func (*RuleGroupSourceStatefulRulesDetails) SetRuleOptions added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesDetails) SetRuleOptions(v []*RuleGroupSourceStatefulRulesOptionsDetails) *RuleGroupSourceStatefulRulesDetails

SetRuleOptions sets the RuleOptions field's value.

func (RuleGroupSourceStatefulRulesDetails) String added in v1.42.24 

func (s RuleGroupSourceStatefulRulesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatefulRulesHeaderDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatefulRulesHeaderDetails) SetDestination(v string) *RuleGroupSourceStatefulRulesHeaderDetails

SetDestination sets the Destination field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetDestinationPort added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesHeaderDetails) SetDestinationPort(v string) *RuleGroupSourceStatefulRulesHeaderDetails

SetDestinationPort sets the DestinationPort field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetDirection added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesHeaderDetails) SetDirection(v string) *RuleGroupSourceStatefulRulesHeaderDetails

SetDirection sets the Direction field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetProtocol added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesHeaderDetails) SetProtocol(v string) *RuleGroupSourceStatefulRulesHeaderDetails

SetProtocol sets the Protocol field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetSource added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesHeaderDetails) SetSource(v string) *RuleGroupSourceStatefulRulesHeaderDetails

SetSource sets the Source field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetSourcePort added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesHeaderDetails) SetSourcePort(v string) *RuleGroupSourceStatefulRulesHeaderDetails

SetSourcePort sets the SourcePort field's value.

func (RuleGroupSourceStatefulRulesHeaderDetails) String added in v1.42.24 

func (s RuleGroupSourceStatefulRulesHeaderDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatefulRulesOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatefulRulesOptionsDetails) SetKeyword(v string) *RuleGroupSourceStatefulRulesOptionsDetails

SetKeyword sets the Keyword field's value.

func (*RuleGroupSourceStatefulRulesOptionsDetails) SetSettings added in v1.42.24 

func (s *RuleGroupSourceStatefulRulesOptionsDetails) SetSettings(v []*string) *RuleGroupSourceStatefulRulesOptionsDetails

SetSettings sets the Settings field's value.

func (RuleGroupSourceStatefulRulesOptionsDetails) String added in v1.42.24 

func (s RuleGroupSourceStatefulRulesOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleDefinition) SetActions(v []*string) *RuleGroupSourceStatelessRuleDefinition

SetActions sets the Actions field's value.

func (*RuleGroupSourceStatelessRuleDefinition) SetMatchAttributes added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleDefinition) SetMatchAttributes(v *RuleGroupSourceStatelessRuleMatchAttributes) *RuleGroupSourceStatelessRuleDefinition

SetMatchAttributes sets the MatchAttributes field's value.

func (RuleGroupSourceStatelessRuleDefinition) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleMatchAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributes) SetDestinationPorts(v []*RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) *RuleGroupSourceStatelessRuleMatchAttributes

SetDestinationPorts sets the DestinationPorts field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetDestinations added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributes) SetDestinations(v []*RuleGroupSourceStatelessRuleMatchAttributesDestinations) *RuleGroupSourceStatelessRuleMatchAttributes

SetDestinations sets the Destinations field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetProtocols added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributes) SetProtocols(v []*int64) *RuleGroupSourceStatelessRuleMatchAttributes

SetProtocols sets the Protocols field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetSourcePorts added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributes) SetSourcePorts(v []*RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) *RuleGroupSourceStatelessRuleMatchAttributes

SetSourcePorts sets the SourcePorts field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetSources added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributes) SetSources(v []*RuleGroupSourceStatelessRuleMatchAttributesSources) *RuleGroupSourceStatelessRuleMatchAttributes

SetSources sets the Sources field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetTcpFlags added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributes) SetTcpFlags(v []*RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) *RuleGroupSourceStatelessRuleMatchAttributes

SetTcpFlags sets the TcpFlags field's value.

func (RuleGroupSourceStatelessRuleMatchAttributes) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleMatchAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) SetFromPort(v int64) *RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts

SetFromPort sets the FromPort field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) SetToPort added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) SetToPort(v int64) *RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts

SetToPort sets the ToPort field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesDestinations) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesDestinations) SetAddressDefinition(v string) *RuleGroupSourceStatelessRuleMatchAttributesDestinations

SetAddressDefinition sets the AddressDefinition field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesDestinations) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesDestinations) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) SetFromPort(v int64) *RuleGroupSourceStatelessRuleMatchAttributesSourcePorts

SetFromPort sets the FromPort field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) SetToPort added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) SetToPort(v int64) *RuleGroupSourceStatelessRuleMatchAttributesSourcePorts

SetToPort sets the ToPort field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesSources) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesSources) SetAddressDefinition(v string) *RuleGroupSourceStatelessRuleMatchAttributesSources

SetAddressDefinition sets the AddressDefinition field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesSources) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesSources) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) SetFlags(v []*string) *RuleGroupSourceStatelessRuleMatchAttributesTcpFlags

SetFlags sets the Flags field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) SetMasks added in v1.42.24 

func (s *RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) SetMasks(v []*string) *RuleGroupSourceStatelessRuleMatchAttributesTcpFlags

SetMasks sets the Masks field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) String added in v1.42.24 

func (s RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRulesAndCustomActionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRulesAndCustomActionsDetails) SetCustomActions(v []*RuleGroupSourceCustomActionsDetails) *RuleGroupSourceStatelessRulesAndCustomActionsDetails

SetCustomActions sets the CustomActions field's value.

func (*RuleGroupSourceStatelessRulesAndCustomActionsDetails) SetStatelessRules added in v1.42.24 

func (s *RuleGroupSourceStatelessRulesAndCustomActionsDetails) SetStatelessRules(v []*RuleGroupSourceStatelessRulesDetails) *RuleGroupSourceStatelessRulesAndCustomActionsDetails

SetStatelessRules sets the StatelessRules field's value.

func (RuleGroupSourceStatelessRulesAndCustomActionsDetails) String added in v1.42.24 

func (s RuleGroupSourceStatelessRulesAndCustomActionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupSourceStatelessRulesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupSourceStatelessRulesDetails) SetPriority(v int64) *RuleGroupSourceStatelessRulesDetails

SetPriority sets the Priority field's value.

func (*RuleGroupSourceStatelessRulesDetails) SetRuleDefinition added in v1.42.24 

func (s *RuleGroupSourceStatelessRulesDetails) SetRuleDefinition(v *RuleGroupSourceStatelessRuleDefinition) *RuleGroupSourceStatelessRulesDetails

SetRuleDefinition sets the RuleDefinition field's value.

func (RuleGroupSourceStatelessRulesDetails) String added in v1.42.24 

func (s RuleGroupSourceStatelessRulesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

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.24 

func (s *RuleGroupVariables) SetIpSets(v *RuleGroupVariablesIpSetsDetails) *RuleGroupVariables

SetIpSets sets the IpSets field's value.

func (*RuleGroupVariables) SetPortSets added in v1.42.24 

func (s *RuleGroupVariables) SetPortSets(v *RuleGroupVariablesPortSetsDetails) *RuleGroupVariables

SetPortSets sets the PortSets field's value.

func (RuleGroupVariables) String added in v1.42.24 

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.24 

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.24 

func (s RuleGroupVariablesIpSetsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupVariablesIpSetsDetails) SetDefinition(v []*string) *RuleGroupVariablesIpSetsDetails

SetDefinition sets the Definition field's value.

func (RuleGroupVariablesIpSetsDetails) String added in v1.42.24 

func (s RuleGroupVariablesIpSetsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s RuleGroupVariablesPortSetsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *RuleGroupVariablesPortSetsDetails) SetDefinition(v []*string) *RuleGroupVariablesPortSetsDetails

SetDefinition sets the Definition field's value.

func (RuleGroupVariablesPortSetsDetails) String added in v1.42.24 

func (s RuleGroupVariablesPortSetsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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"`

	// The most recent reason for updating the customizable properties of a security
	// control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations
	// (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html)
	// API, which tracks the reason for updating the enablement status of a control.
	// This field accepts alphanumeric characters in addition to white spaces, dashes,
	// and underscores.
	LastUpdateReason *string `type:"string"`

	// An object that identifies the name of a control parameter, its current value,
	// and whether it has been customized.
	Parameters map[string]*ParameterConfiguration `type:"map"`

	// 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"`

	// Identifies whether customizable properties of a security control are reflected
	// in Security Hub findings. A status of READY indicates findings include the
	// current parameter values. A status of UPDATING indicates that all findings
	// may not include the current parameter values.
	UpdateStatus *string `type:"string" enum:"UpdateStatus"`
	// 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.44.209 

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.44.209 

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

SetDescription sets the Description field's value.

func (*SecurityControl) SetLastUpdateReason added in v1.48.4 

func (s *SecurityControl) SetLastUpdateReason(v string) *SecurityControl

SetLastUpdateReason sets the LastUpdateReason field's value.

func (*SecurityControl) SetParameters added in v1.48.4 

func (s *SecurityControl) SetParameters(v map[string]*ParameterConfiguration) *SecurityControl

SetParameters sets the Parameters field's value.

func (*SecurityControl) SetRemediationUrl added in v1.44.209 

func (s *SecurityControl) SetRemediationUrl(v string) *SecurityControl

SetRemediationUrl sets the RemediationUrl field's value.

func (*SecurityControl) SetSecurityControlArn added in v1.44.209 

func (s *SecurityControl) SetSecurityControlArn(v string) *SecurityControl

SetSecurityControlArn sets the SecurityControlArn field's value.

func (*SecurityControl) SetSecurityControlId added in v1.44.209 

func (s *SecurityControl) SetSecurityControlId(v string) *SecurityControl

SetSecurityControlId sets the SecurityControlId field's value.

func (*SecurityControl) SetSecurityControlStatus added in v1.44.209 

func (s *SecurityControl) SetSecurityControlStatus(v string) *SecurityControl

SetSecurityControlStatus sets the SecurityControlStatus field's value.

func (*SecurityControl) SetSeverityRating added in v1.44.209 

func (s *SecurityControl) SetSeverityRating(v string) *SecurityControl

SetSeverityRating sets the SeverityRating field's value.

func (*SecurityControl) SetTitle added in v1.44.209 

func (s *SecurityControl) SetTitle(v string) *SecurityControl

SetTitle sets the Title field's value.

func (*SecurityControl) SetUpdateStatus added in v1.48.4 

func (s *SecurityControl) SetUpdateStatus(v string) *SecurityControl

SetUpdateStatus sets the UpdateStatus field's value.

func (SecurityControl) String added in v1.44.209 

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 SecurityControlCustomParameter added in v1.48.5 

type SecurityControlCustomParameter struct {

	// An object that specifies parameter values for a control in a configuration
	// policy.
	Parameters map[string]*ParameterConfiguration `type:"map"`

	// The ID of the security control.
	SecurityControlId *string `type:"string"`
	// contains filtered or unexported fields
}

A list of security controls and control parameter values that are included in a configuration policy.

func (SecurityControlCustomParameter) GoString added in v1.48.5 

func (s SecurityControlCustomParameter) GoString() string

GoString returns the string representation.

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

func (*SecurityControlCustomParameter) SetParameters added in v1.48.5 

func (s *SecurityControlCustomParameter) SetParameters(v map[string]*ParameterConfiguration) *SecurityControlCustomParameter

SetParameters sets the Parameters field's value.

func (*SecurityControlCustomParameter) SetSecurityControlId added in v1.48.5 

func (s *SecurityControlCustomParameter) SetSecurityControlId(v string) *SecurityControlCustomParameter

SetSecurityControlId sets the SecurityControlId field's value.

func (SecurityControlCustomParameter) String added in v1.48.5 

func (s SecurityControlCustomParameter) String() string

String returns the string representation.

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

func (*SecurityControlCustomParameter) Validate added in v1.48.5 

func (s *SecurityControlCustomParameter) Validate() error

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

type SecurityControlDefinition added in v1.44.209 

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"`

	// Security control properties that you can customize. Currently, only parameter
	// customization is supported for select controls. An empty array is returned
	// for controls that don’t support custom properties.
	CustomizableProperties []*string `type:"list" enum:"SecurityControlProperty"`

	// 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"`

	// An object that provides a security control parameter name, description, and
	// the options for customizing it. This object is excluded for a control that
	// doesn't support custom parameters.
	ParameterDefinitions map[string]*ParameterDefinition `type:"map"`

	// 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.44.209 

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.44.209 

func (s *SecurityControlDefinition) SetCurrentRegionAvailability(v string) *SecurityControlDefinition

SetCurrentRegionAvailability sets the CurrentRegionAvailability field's value.

func (*SecurityControlDefinition) SetCustomizableProperties added in v1.48.4 

func (s *SecurityControlDefinition) SetCustomizableProperties(v []*string) *SecurityControlDefinition

SetCustomizableProperties sets the CustomizableProperties field's value.

func (*SecurityControlDefinition) SetDescription added in v1.44.209 

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

SetDescription sets the Description field's value.

func (*SecurityControlDefinition) SetParameterDefinitions added in v1.48.4 

func (s *SecurityControlDefinition) SetParameterDefinitions(v map[string]*ParameterDefinition) *SecurityControlDefinition

SetParameterDefinitions sets the ParameterDefinitions field's value.

func (*SecurityControlDefinition) SetRemediationUrl added in v1.44.209 

func (s *SecurityControlDefinition) SetRemediationUrl(v string) *SecurityControlDefinition

SetRemediationUrl sets the RemediationUrl field's value.

func (*SecurityControlDefinition) SetSecurityControlId added in v1.44.209 

func (s *SecurityControlDefinition) SetSecurityControlId(v string) *SecurityControlDefinition

SetSecurityControlId sets the SecurityControlId field's value.

func (*SecurityControlDefinition) SetSeverityRating added in v1.44.209 

func (s *SecurityControlDefinition) SetSeverityRating(v string) *SecurityControlDefinition

SetSeverityRating sets the SeverityRating field's value.

func (*SecurityControlDefinition) SetTitle added in v1.44.209 

func (s *SecurityControlDefinition) SetTitle(v string) *SecurityControlDefinition

SetTitle sets the Title field's value.

func (SecurityControlDefinition) String added in v1.44.209 

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 SecurityControlParameter added in v1.48.4 

type SecurityControlParameter struct {

	// The name of a
	Name *string `type:"string"`

	// The current value of a control parameter.
	Value []*string `type:"list"`
	// contains filtered or unexported fields
}

A parameter that a security control accepts.

func (SecurityControlParameter) GoString added in v1.48.4 

func (s SecurityControlParameter) GoString() string

GoString returns the string representation.

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

func (*SecurityControlParameter) SetName added in v1.48.4 

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

SetName sets the Name field's value.

func (*SecurityControlParameter) SetValue added in v1.48.4 

func (s *SecurityControlParameter) SetValue(v []*string) *SecurityControlParameter

SetValue sets the Value field's value.

func (SecurityControlParameter) String added in v1.48.4 

func (s SecurityControlParameter) String() string

String returns the string representation.

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

type SecurityControlsConfiguration added in v1.48.5 

type SecurityControlsConfiguration struct {

	// A list of security controls that are disabled in the configuration policy.
	// Security Hub enables all other controls (including newly released controls)
	// other than the listed controls.
	DisabledSecurityControlIdentifiers []*string `type:"list"`

	// A list of security controls that are enabled in the configuration policy.
	// Security Hub disables all other controls (including newly released controls)
	// other than the listed controls.
	EnabledSecurityControlIdentifiers []*string `type:"list"`

	// A list of security controls and control parameter values that are included
	// in a configuration policy.
	SecurityControlCustomParameters []*SecurityControlCustomParameter `type:"list"`
	// contains filtered or unexported fields
}

An object that defines which security controls are enabled in an Security Hub configuration policy. The enablement status of a control is aligned across all of the enabled standards in an account.

func (SecurityControlsConfiguration) GoString added in v1.48.5 

func (s SecurityControlsConfiguration) GoString() string

GoString returns the string representation.

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

func (*SecurityControlsConfiguration) SetDisabledSecurityControlIdentifiers added in v1.48.5 

func (s *SecurityControlsConfiguration) SetDisabledSecurityControlIdentifiers(v []*string) *SecurityControlsConfiguration

SetDisabledSecurityControlIdentifiers sets the DisabledSecurityControlIdentifiers field's value.

func (*SecurityControlsConfiguration) SetEnabledSecurityControlIdentifiers added in v1.48.5 

func (s *SecurityControlsConfiguration) SetEnabledSecurityControlIdentifiers(v []*string) *SecurityControlsConfiguration

SetEnabledSecurityControlIdentifiers sets the EnabledSecurityControlIdentifiers field's value.

func (*SecurityControlsConfiguration) SetSecurityControlCustomParameters added in v1.48.5 

func (s *SecurityControlsConfiguration) SetSecurityControlCustomParameters(v []*SecurityControlCustomParameter) *SecurityControlsConfiguration

SetSecurityControlCustomParameters sets the SecurityControlCustomParameters field's value.

func (SecurityControlsConfiguration) String added in v1.48.5 

func (s SecurityControlsConfiguration) String() string

String returns the string representation.

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

func (*SecurityControlsConfiguration) Validate added in v1.48.5 

func (s *SecurityControlsConfiguration) Validate() error

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

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 added in v1.38.24 

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 added in v1.38.24 

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 added in v1.38.24 

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.44.282 

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.44.282 

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.44.282 

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.

  • 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/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())
			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) 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.

  • 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/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())
			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) 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.44.282 

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.44.282 

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.44.282 

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) BatchGetConfigurationPolicyAssociations added in v1.48.5 

func (c *SecurityHub) BatchGetConfigurationPolicyAssociations(input *BatchGetConfigurationPolicyAssociationsInput) (*BatchGetConfigurationPolicyAssociationsOutput, error)

BatchGetConfigurationPolicyAssociations API operation for AWS SecurityHub.

Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed 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 BatchGetConfigurationPolicyAssociations 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.

  • 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/BatchGetConfigurationPolicyAssociations

Example (Shared00)

To get configuration associations for a batch of targets This operation provides details about configuration associations for a batch of target accounts, organizational units, or the root. 

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.BatchGetConfigurationPolicyAssociationsInput{
		ConfigurationPolicyAssociationIdentifiers: []*securityhub.ConfigurationPolicyAssociation{
			{
				Target: &securityhub.Target{
					AccountId: aws.String("111122223333"),
				},
			},
			{
				Target: &securityhub.Target{
					RootId: aws.String("r-f6g7h8i9j0example"),
				},
			},
		},
	}

	result, err := svc.BatchGetConfigurationPolicyAssociations(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())
			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) BatchGetConfigurationPolicyAssociationsRequest added in v1.48.5 

func (c *SecurityHub) BatchGetConfigurationPolicyAssociationsRequest(input *BatchGetConfigurationPolicyAssociationsInput) (req *request.Request, output *BatchGetConfigurationPolicyAssociationsOutput)

BatchGetConfigurationPolicyAssociationsRequest generates a "aws/request.Request" representing the client's request for the BatchGetConfigurationPolicyAssociations 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 BatchGetConfigurationPolicyAssociations for more information on using the BatchGetConfigurationPolicyAssociations 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 BatchGetConfigurationPolicyAssociationsRequest method.
req, resp := client.BatchGetConfigurationPolicyAssociationsRequest(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/BatchGetConfigurationPolicyAssociations

func (*SecurityHub) BatchGetConfigurationPolicyAssociationsWithContext added in v1.48.5 

func (c *SecurityHub) BatchGetConfigurationPolicyAssociationsWithContext(ctx aws.Context, input *BatchGetConfigurationPolicyAssociationsInput, opts ...request.Option) (*BatchGetConfigurationPolicyAssociationsOutput, error)

BatchGetConfigurationPolicyAssociationsWithContext is the same as BatchGetConfigurationPolicyAssociations with the addition of the ability to pass a context and additional request options.

See BatchGetConfigurationPolicyAssociations 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.44.209 

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.44.209 

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.44.209 

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.44.209 

func (c *SecurityHub) BatchGetStandardsControlAssociations(input *BatchGetStandardsControlAssociationsInput) (*BatchGetStandardsControlAssociationsOutput, error)

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.44.209 

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.44.209 

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.44.282 

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.44.282 

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.44.282 

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 added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

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.44.209 

func (c *SecurityHub) BatchUpdateStandardsControlAssociations(input *BatchUpdateStandardsControlAssociationsInput) (*BatchUpdateStandardsControlAssociationsOutput, error)

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.

  • 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/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())
			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) BatchUpdateStandardsControlAssociationsRequest added in v1.44.209 

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.44.209 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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.44.282 

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.44.282 

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.44.282 

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) CreateConfigurationPolicy added in v1.48.5 

func (c *SecurityHub) CreateConfigurationPolicy(input *CreateConfigurationPolicyInput) (*CreateConfigurationPolicyOutput, error)

CreateConfigurationPolicy API operation for AWS SecurityHub.

Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home 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 CreateConfigurationPolicy 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.

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

  • 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/CreateConfigurationPolicy

Example (Shared00)

To create a configuration policy This operation creates a configuration policy 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.CreateConfigurationPolicyInput{
		ConfigurationPolicy: &securityhub.Policy{
			SecurityHub: &securityhub.SecurityHubPolicy{
				EnabledStandardIdentifiers: []*string{
					aws.String("arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0"),
					aws.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
				},
				SecurityControlsConfiguration: &securityhub.SecurityControlsConfiguration{
					DisabledSecurityControlIdentifiers: []*string{
						aws.String("CloudWatch.1"),
					},
					SecurityControlCustomParameters: []*securityhub.SecurityControlCustomParameter{
						{
							Parameters: map[string]*securityhub.ParameterConfiguration{
								"daysToExpiration": {
									Value: &securityhub.ParameterValue{
										Integer: aws.Int64(14),
									},
									ValueType: aws.String("CUSTOM"),
								},
							},
							SecurityControlId: aws.String("ACM.1"),
						},
					},
				},
				ServiceEnabled: aws.Bool(true),
			},
		},
		Description: aws.String("Configuration policy for testing FSBP and CIS"),
		Name:        aws.String("TestConfigurationPolicy"),
	}

	result, err := svc.CreateConfigurationPolicy(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.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, 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) CreateConfigurationPolicyRequest added in v1.48.5 

func (c *SecurityHub) CreateConfigurationPolicyRequest(input *CreateConfigurationPolicyInput) (req *request.Request, output *CreateConfigurationPolicyOutput)

CreateConfigurationPolicyRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationPolicy 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 CreateConfigurationPolicy for more information on using the CreateConfigurationPolicy 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 CreateConfigurationPolicyRequest method.
req, resp := client.CreateConfigurationPolicyRequest(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/CreateConfigurationPolicy

func (*SecurityHub) CreateConfigurationPolicyWithContext added in v1.48.5 

func (c *SecurityHub) CreateConfigurationPolicyWithContext(ctx aws.Context, input *CreateConfigurationPolicyInput, opts ...request.Option) (*CreateConfigurationPolicyOutput, error)

CreateConfigurationPolicyWithContext is the same as CreateConfigurationPolicy with the addition of the ability to pass a context and additional request options.

See CreateConfigurationPolicy 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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.

  • 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/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())
			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) 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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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) DeleteConfigurationPolicy added in v1.48.5 

func (c *SecurityHub) DeleteConfigurationPolicy(input *DeleteConfigurationPolicyInput) (*DeleteConfigurationPolicyOutput, error)

DeleteConfigurationPolicy API operation for AWS SecurityHub.

Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the StartConfigurationPolicyDisassociation 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 DeleteConfigurationPolicy 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.

  • 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/DeleteConfigurationPolicy

Example (Shared00)

To delete a configuration policy This operation deletes the specified configuration policy. 

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.DeleteConfigurationPolicyInput{
		Identifier: aws.String("arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
	}

	result, err := svc.DeleteConfigurationPolicy(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())
			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) DeleteConfigurationPolicyRequest added in v1.48.5 

func (c *SecurityHub) DeleteConfigurationPolicyRequest(input *DeleteConfigurationPolicyInput) (req *request.Request, output *DeleteConfigurationPolicyOutput)

DeleteConfigurationPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationPolicy 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 DeleteConfigurationPolicy for more information on using the DeleteConfigurationPolicy 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 DeleteConfigurationPolicyRequest method.
req, resp := client.DeleteConfigurationPolicyRequest(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/DeleteConfigurationPolicy

func (*SecurityHub) DeleteConfigurationPolicyWithContext added in v1.48.5 

func (c *SecurityHub) DeleteConfigurationPolicyWithContext(ctx aws.Context, input *DeleteConfigurationPolicyInput, opts ...request.Option) (*DeleteConfigurationPolicyOutput, error)

DeleteConfigurationPolicyWithContext is the same as DeleteConfigurationPolicy with the addition of the ability to pass a context and additional request options.

See DeleteConfigurationPolicy 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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.

You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.35.34 

func (c *SecurityHub) DescribeOrganizationConfiguration(input *DescribeOrganizationConfigurationInput) (*DescribeOrganizationConfigurationOutput, error)

DescribeOrganizationConfiguration API operation for AWS SecurityHub.

Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this 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 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 organization configuration This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke 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 added in v1.35.34 

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 added in v1.35.34 

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 added in v1.19.40 

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 added in v1.19.40 

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 added in v1.19.40 

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 added in v1.19.40 

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 added in v1.19.40 

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 added in v1.29.3 

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 added in v1.28.3 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.28.3 

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 added in v1.28.3 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

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 

func (c *SecurityHub) DisableImportFindingsForProduct(input *DisableImportFindingsForProductInput) (*DisableImportFindingsForProductOutput, error)

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 added in v1.35.34 

func (c *SecurityHub) DisableOrganizationAdminAccount(input *DisableOrganizationAdminAccountInput) (*DisableOrganizationAdminAccountOutput, error)

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.

  • 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/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())
			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) DisableOrganizationAdminAccountRequest added in v1.35.34 

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 added in v1.35.34 

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 Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.

You can't disable Security Hub in an account that is currently the Security Hub administrator.

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.

  • 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/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())
			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) 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 added in v1.38.24 

func (c *SecurityHub) DisassociateFromAdministratorAccount(input *DisassociateFromAdministratorAccountInput) (*DisassociateFromAdministratorAccountOutput, error)

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 added in v1.38.24 

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 added in v1.38.24 

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.

  • 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/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())
			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) 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 added in v1.35.34 

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.

  • 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/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())
			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) EnableOrganizationAdminAccountRequest added in v1.35.34 

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 added in v1.35.34 

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 added in v1.38.24 

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 added in v1.38.24 

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 added in v1.38.24 

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) GetConfigurationPolicy added in v1.48.5 

func (c *SecurityHub) GetConfigurationPolicy(input *GetConfigurationPolicyInput) (*GetConfigurationPolicyOutput, error)

GetConfigurationPolicy API operation for AWS SecurityHub.

Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home 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 GetConfigurationPolicy 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.

  • 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/GetConfigurationPolicy

Example (Shared00)

To get details about a configuration policy This operation provides details about the specified configuration policy. 

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.GetConfigurationPolicyInput{
		Identifier: aws.String("arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
	}

	result, err := svc.GetConfigurationPolicy(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())
			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) GetConfigurationPolicyAssociation added in v1.48.5 

func (c *SecurityHub) GetConfigurationPolicyAssociation(input *GetConfigurationPolicyAssociationInput) (*GetConfigurationPolicyAssociationOutput, error)

GetConfigurationPolicyAssociation API operation for AWS SecurityHub.

Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home 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 GetConfigurationPolicyAssociation 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.

  • 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/GetConfigurationPolicyAssociation

Example (Shared00)

To get details about a configuration association This operation provides details about configuration associations for a specific target account, organizational unit, or the root. 

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.GetConfigurationPolicyAssociationInput{
		Target: &securityhub.Target{
			AccountId: aws.String("111122223333"),
		},
	}

	result, err := svc.GetConfigurationPolicyAssociation(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())
			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) GetConfigurationPolicyAssociationRequest added in v1.48.5 

func (c *SecurityHub) GetConfigurationPolicyAssociationRequest(input *GetConfigurationPolicyAssociationInput) (req *request.Request, output *GetConfigurationPolicyAssociationOutput)

GetConfigurationPolicyAssociationRequest generates a "aws/request.Request" representing the client's request for the GetConfigurationPolicyAssociation 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 GetConfigurationPolicyAssociation for more information on using the GetConfigurationPolicyAssociation 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 GetConfigurationPolicyAssociationRequest method.
req, resp := client.GetConfigurationPolicyAssociationRequest(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/GetConfigurationPolicyAssociation

func (*SecurityHub) GetConfigurationPolicyAssociationWithContext added in v1.48.5 

func (c *SecurityHub) GetConfigurationPolicyAssociationWithContext(ctx aws.Context, input *GetConfigurationPolicyAssociationInput, opts ...request.Option) (*GetConfigurationPolicyAssociationOutput, error)

GetConfigurationPolicyAssociationWithContext is the same as GetConfigurationPolicyAssociation with the addition of the ability to pass a context and additional request options.

See GetConfigurationPolicyAssociation 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) GetConfigurationPolicyRequest added in v1.48.5 

func (c *SecurityHub) GetConfigurationPolicyRequest(input *GetConfigurationPolicyInput) (req *request.Request, output *GetConfigurationPolicyOutput)

GetConfigurationPolicyRequest generates a "aws/request.Request" representing the client's request for the GetConfigurationPolicy 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 GetConfigurationPolicy for more information on using the GetConfigurationPolicy 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 GetConfigurationPolicyRequest method.
req, resp := client.GetConfigurationPolicyRequest(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/GetConfigurationPolicy

func (*SecurityHub) GetConfigurationPolicyWithContext added in v1.48.5 

func (c *SecurityHub) GetConfigurationPolicyWithContext(ctx aws.Context, input *GetConfigurationPolicyInput, opts ...request.Option) (*GetConfigurationPolicyOutput, error)

GetConfigurationPolicyWithContext is the same as GetConfigurationPolicy with the addition of the ability to pass a context and additional request options.

See GetConfigurationPolicy 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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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.44.257 

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.44.257 

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.44.257 

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.44.257 

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.44.257 

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) GetSecurityControlDefinition added in v1.48.4 

func (c *SecurityHub) GetSecurityControlDefinition(input *GetSecurityControlDefinitionInput) (*GetSecurityControlDefinitionOutput, error)

GetSecurityControlDefinition API operation for AWS SecurityHub.

Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.

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 GetSecurityControlDefinition 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/GetSecurityControlDefinition

Example (Shared00)

To get the definition of a security control. The following example retrieves definition details for the specified security 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.GetSecurityControlDefinitionInput{
		SecurityControlId: aws.String("EC2.4"),
	}

	result, err := svc.GetSecurityControlDefinition(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) GetSecurityControlDefinitionRequest added in v1.48.4 

func (c *SecurityHub) GetSecurityControlDefinitionRequest(input *GetSecurityControlDefinitionInput) (req *request.Request, output *GetSecurityControlDefinitionOutput)

GetSecurityControlDefinitionRequest generates a "aws/request.Request" representing the client's request for the GetSecurityControlDefinition 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 GetSecurityControlDefinition for more information on using the GetSecurityControlDefinition 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 GetSecurityControlDefinitionRequest method.
req, resp := client.GetSecurityControlDefinitionRequest(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/GetSecurityControlDefinition

func (*SecurityHub) GetSecurityControlDefinitionWithContext added in v1.48.4 

func (c *SecurityHub) GetSecurityControlDefinitionWithContext(ctx aws.Context, input *GetSecurityControlDefinitionInput, opts ...request.Option) (*GetSecurityControlDefinitionOutput, error)

GetSecurityControlDefinitionWithContext is the same as GetSecurityControlDefinition with the addition of the ability to pass a context and additional request options.

See GetSecurityControlDefinition 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.44.282 

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.44.282 

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.44.282 

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) ListConfigurationPolicies added in v1.48.5 

func (c *SecurityHub) ListConfigurationPolicies(input *ListConfigurationPoliciesInput) (*ListConfigurationPoliciesOutput, error)

ListConfigurationPolicies API operation for AWS SecurityHub.

Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home 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 ListConfigurationPolicies 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.

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

  • 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/ListConfigurationPolicies

Example (Shared00)

To view a list of configuration policies This operation provides a list of your configuration policies, including metadata for each policy. 

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.ListConfigurationPoliciesInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf"),
	}

	result, err := svc.ListConfigurationPolicies(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.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) ListConfigurationPoliciesPages added in v1.48.5 

func (c *SecurityHub) ListConfigurationPoliciesPages(input *ListConfigurationPoliciesInput, fn func(*ListConfigurationPoliciesOutput, bool) bool) error

ListConfigurationPoliciesPages iterates over the pages of a ListConfigurationPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConfigurationPolicies 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 ListConfigurationPolicies operation.
pageNum := 0
err := client.ListConfigurationPoliciesPages(params,
    func(page *securityhub.ListConfigurationPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListConfigurationPoliciesPagesWithContext added in v1.48.5 

func (c *SecurityHub) ListConfigurationPoliciesPagesWithContext(ctx aws.Context, input *ListConfigurationPoliciesInput, fn func(*ListConfigurationPoliciesOutput, bool) bool, opts ...request.Option) error

ListConfigurationPoliciesPagesWithContext same as ListConfigurationPoliciesPages 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) ListConfigurationPoliciesRequest added in v1.48.5 

func (c *SecurityHub) ListConfigurationPoliciesRequest(input *ListConfigurationPoliciesInput) (req *request.Request, output *ListConfigurationPoliciesOutput)

ListConfigurationPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListConfigurationPolicies 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 ListConfigurationPolicies for more information on using the ListConfigurationPolicies 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 ListConfigurationPoliciesRequest method.
req, resp := client.ListConfigurationPoliciesRequest(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/ListConfigurationPolicies

func (*SecurityHub) ListConfigurationPoliciesWithContext added in v1.48.5 

func (c *SecurityHub) ListConfigurationPoliciesWithContext(ctx aws.Context, input *ListConfigurationPoliciesInput, opts ...request.Option) (*ListConfigurationPoliciesOutput, error)

ListConfigurationPoliciesWithContext is the same as ListConfigurationPolicies with the addition of the ability to pass a context and additional request options.

See ListConfigurationPolicies 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) ListConfigurationPolicyAssociations added in v1.48.5 

func (c *SecurityHub) ListConfigurationPolicyAssociations(input *ListConfigurationPolicyAssociationsInput) (*ListConfigurationPolicyAssociationsOutput, error)

ListConfigurationPolicyAssociations API operation for AWS SecurityHub.

Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home 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 ListConfigurationPolicyAssociations 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.

  • 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/ListConfigurationPolicyAssociations

Example (Shared00)

To list configuration associations This operation lists all of the associations between targets and configuration policies or self-managed behavior. Targets can include accounts, organizational units, or the root. 

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.ListConfigurationPolicyAssociationsInput{
		Filters: &securityhub.AssociationFilters{
			AssociationType: aws.String("APPLIED"),
		},
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf"),
	}

	result, err := svc.ListConfigurationPolicyAssociations(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.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) ListConfigurationPolicyAssociationsPages added in v1.48.5 

func (c *SecurityHub) ListConfigurationPolicyAssociationsPages(input *ListConfigurationPolicyAssociationsInput, fn func(*ListConfigurationPolicyAssociationsOutput, bool) bool) error

ListConfigurationPolicyAssociationsPages iterates over the pages of a ListConfigurationPolicyAssociations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConfigurationPolicyAssociations 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 ListConfigurationPolicyAssociations operation.
pageNum := 0
err := client.ListConfigurationPolicyAssociationsPages(params,
    func(page *securityhub.ListConfigurationPolicyAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListConfigurationPolicyAssociationsPagesWithContext added in v1.48.5 

func (c *SecurityHub) ListConfigurationPolicyAssociationsPagesWithContext(ctx aws.Context, input *ListConfigurationPolicyAssociationsInput, fn func(*ListConfigurationPolicyAssociationsOutput, bool) bool, opts ...request.Option) error

ListConfigurationPolicyAssociationsPagesWithContext same as ListConfigurationPolicyAssociationsPages 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) ListConfigurationPolicyAssociationsRequest added in v1.48.5 

func (c *SecurityHub) ListConfigurationPolicyAssociationsRequest(input *ListConfigurationPolicyAssociationsInput) (req *request.Request, output *ListConfigurationPolicyAssociationsOutput)

ListConfigurationPolicyAssociationsRequest generates a "aws/request.Request" representing the client's request for the ListConfigurationPolicyAssociations 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 ListConfigurationPolicyAssociations for more information on using the ListConfigurationPolicyAssociations 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 ListConfigurationPolicyAssociationsRequest method.
req, resp := client.ListConfigurationPolicyAssociationsRequest(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/ListConfigurationPolicyAssociations

func (*SecurityHub) ListConfigurationPolicyAssociationsWithContext added in v1.48.5 

func (c *SecurityHub) ListConfigurationPolicyAssociationsWithContext(ctx aws.Context, input *ListConfigurationPolicyAssociationsInput, opts ...request.Option) (*ListConfigurationPolicyAssociationsOutput, error)

ListConfigurationPolicyAssociationsWithContext is the same as ListConfigurationPolicyAssociations with the addition of the ability to pass a context and additional request options.

See ListConfigurationPolicyAssociations 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.35.34 

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 added in v1.35.34 

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 added in v1.35.34 

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 added in v1.35.34 

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 added in v1.35.34 

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.44.209 

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.44.209 

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.44.209 

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.44.209 

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.44.209 

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.44.209 

func (c *SecurityHub) ListStandardsControlAssociations(input *ListStandardsControlAssociationsInput) (*ListStandardsControlAssociationsOutput, error)

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.44.209 

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.44.209 

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.44.209 

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.44.209 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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) StartConfigurationPolicyAssociation added in v1.48.5 

func (c *SecurityHub) StartConfigurationPolicyAssociation(input *StartConfigurationPolicyAssociationInput) (*StartConfigurationPolicyAssociationOutput, error)

StartConfigurationPolicyAssociation API operation for AWS SecurityHub.

Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home 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 StartConfigurationPolicyAssociation 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.

  • 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/StartConfigurationPolicyAssociation

Example (Shared00)

To associate a configuration with a target This operation associates a configuration policy or self-managed behavior with the target account, organizational unit, or the root. 

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.StartConfigurationPolicyAssociationInput{
		ConfigurationPolicyIdentifier: aws.String("arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
		Target: &securityhub.Target{
			AccountId: aws.String("111122223333"),
		},
	}

	result, err := svc.StartConfigurationPolicyAssociation(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())
			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) StartConfigurationPolicyAssociationRequest added in v1.48.5 

func (c *SecurityHub) StartConfigurationPolicyAssociationRequest(input *StartConfigurationPolicyAssociationInput) (req *request.Request, output *StartConfigurationPolicyAssociationOutput)

StartConfigurationPolicyAssociationRequest generates a "aws/request.Request" representing the client's request for the StartConfigurationPolicyAssociation 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 StartConfigurationPolicyAssociation for more information on using the StartConfigurationPolicyAssociation 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 StartConfigurationPolicyAssociationRequest method.
req, resp := client.StartConfigurationPolicyAssociationRequest(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/StartConfigurationPolicyAssociation

func (*SecurityHub) StartConfigurationPolicyAssociationWithContext added in v1.48.5 

func (c *SecurityHub) StartConfigurationPolicyAssociationWithContext(ctx aws.Context, input *StartConfigurationPolicyAssociationInput, opts ...request.Option) (*StartConfigurationPolicyAssociationOutput, error)

StartConfigurationPolicyAssociationWithContext is the same as StartConfigurationPolicyAssociation with the addition of the ability to pass a context and additional request options.

See StartConfigurationPolicyAssociation 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) StartConfigurationPolicyDisassociation added in v1.48.5 

func (c *SecurityHub) StartConfigurationPolicyDisassociation(input *StartConfigurationPolicyDisassociationInput) (*StartConfigurationPolicyDisassociationOutput, error)

StartConfigurationPolicyDisassociation API operation for AWS SecurityHub.

Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home 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 StartConfigurationPolicyDisassociation 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.

  • 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/StartConfigurationPolicyDisassociation

Example (Shared00)

To disassociate a configuration from a target This operation disassociates a configuration policy or self-managed behavior from the target account, organizational unit, or the root. 

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.StartConfigurationPolicyDisassociationInput{
		ConfigurationPolicyIdentifier: aws.String("SELF_MANAGED_SECURITY_HUB"),
		Target: &securityhub.Target{
			RootId: aws.String("r-f6g7h8i9j0example"),
		},
	}

	result, err := svc.StartConfigurationPolicyDisassociation(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())
			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) StartConfigurationPolicyDisassociationRequest added in v1.48.5 

func (c *SecurityHub) StartConfigurationPolicyDisassociationRequest(input *StartConfigurationPolicyDisassociationInput) (req *request.Request, output *StartConfigurationPolicyDisassociationOutput)

StartConfigurationPolicyDisassociationRequest generates a "aws/request.Request" representing the client's request for the StartConfigurationPolicyDisassociation 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 StartConfigurationPolicyDisassociation for more information on using the StartConfigurationPolicyDisassociation 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 StartConfigurationPolicyDisassociationRequest method.
req, resp := client.StartConfigurationPolicyDisassociationRequest(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/StartConfigurationPolicyDisassociation

func (*SecurityHub) StartConfigurationPolicyDisassociationWithContext added in v1.48.5 

func (c *SecurityHub) StartConfigurationPolicyDisassociationWithContext(ctx aws.Context, input *StartConfigurationPolicyDisassociationInput, opts ...request.Option) (*StartConfigurationPolicyDisassociationOutput, error)

StartConfigurationPolicyDisassociationWithContext is the same as StartConfigurationPolicyDisassociation with the addition of the ability to pass a context and additional request options.

See StartConfigurationPolicyDisassociation 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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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) UpdateConfigurationPolicy added in v1.48.5 

func (c *SecurityHub) UpdateConfigurationPolicy(input *UpdateConfigurationPolicyInput) (*UpdateConfigurationPolicyOutput, error)

UpdateConfigurationPolicy API operation for AWS SecurityHub.

Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home 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 UpdateConfigurationPolicy 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.

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

  • 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/UpdateConfigurationPolicy

Example (Shared00)

To update a configuration policy This operation updates the specified configuration policy. 

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.UpdateConfigurationPolicyInput{
		ConfigurationPolicy: &securityhub.Policy{
			SecurityHub: &securityhub.SecurityHubPolicy{
				EnabledStandardIdentifiers: []*string{
					aws.String("arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0"),
					aws.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
				},
				SecurityControlsConfiguration: &securityhub.SecurityControlsConfiguration{
					DisabledSecurityControlIdentifiers: []*string{
						aws.String("CloudWatch.1"),
						aws.String("CloudWatch.2"),
					},
					SecurityControlCustomParameters: []*securityhub.SecurityControlCustomParameter{
						{
							Parameters: map[string]*securityhub.ParameterConfiguration{
								"daysToExpiration": {
									Value: &securityhub.ParameterValue{
										Integer: aws.Int64(21),
									},
									ValueType: aws.String("CUSTOM"),
								},
							},
							SecurityControlId: aws.String("ACM.1"),
						},
					},
				},
				ServiceEnabled: aws.Bool(true),
			},
		},
		Description:   aws.String("Updated configuration policy for testing FSBP and CIS"),
		Identifier:    aws.String("arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
		Name:          aws.String("TestConfigurationPolicy"),
		UpdatedReason: aws.String("Enabling ACM.2"),
	}

	result, err := svc.UpdateConfigurationPolicy(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())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, 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) UpdateConfigurationPolicyRequest added in v1.48.5 

func (c *SecurityHub) UpdateConfigurationPolicyRequest(input *UpdateConfigurationPolicyInput) (req *request.Request, output *UpdateConfigurationPolicyOutput)

UpdateConfigurationPolicyRequest generates a "aws/request.Request" representing the client's request for the UpdateConfigurationPolicy 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 UpdateConfigurationPolicy for more information on using the UpdateConfigurationPolicy 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 UpdateConfigurationPolicyRequest method.
req, resp := client.UpdateConfigurationPolicyRequest(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/UpdateConfigurationPolicy

func (*SecurityHub) UpdateConfigurationPolicyWithContext added in v1.48.5 

func (c *SecurityHub) UpdateConfigurationPolicyWithContext(ctx aws.Context, input *UpdateConfigurationPolicyInput, opts ...request.Option) (*UpdateConfigurationPolicyOutput, error)

UpdateConfigurationPolicyWithContext is the same as UpdateConfigurationPolicy with the addition of the ability to pass a context and additional request options.

See UpdateConfigurationPolicy 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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

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 added in v1.35.34 

func (c *SecurityHub) UpdateOrganizationConfiguration(input *UpdateOrganizationConfigurationInput) (*UpdateOrganizationConfigurationOutput, error)

UpdateOrganizationConfiguration API operation for AWS SecurityHub.

Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this 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 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.

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

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • 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/UpdateOrganizationConfiguration

Example (Shared00)

To update organization configuration This operation updates the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke 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(false),
		AutoEnableStandards: aws.String("NONE"),
		OrganizationConfiguration: &securityhub.OrganizationConfiguration{
			ConfigurationType: aws.String("CENTRAL"),
		},
	}

	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())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, 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) UpdateOrganizationConfigurationRequest added in v1.35.34 

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 added in v1.35.34 

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) UpdateSecurityControl added in v1.48.4 

func (c *SecurityHub) UpdateSecurityControl(input *UpdateSecurityControlInput) (*UpdateSecurityControlOutput, error)

UpdateSecurityControl API operation for AWS SecurityHub.

Updates the properties of a security control.

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 UpdateSecurityControl 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.

  • ResourceInUseException The request was rejected because it conflicts with the resource's availability. For example, you tried to update a security control that's currently in the UPDATING state.

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

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • ResourceInUseException The request was rejected because it conflicts with the resource's availability. For example, you tried to update a security control that's currently in the UPDATING state.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateSecurityControl

Example (Shared00)

To update security control properties The following example updates the specified security control. Specifically, this example updates control parameters. 

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.UpdateSecurityControlInput{
		LastUpdateReason: aws.String("Comply with internal requirements"),
		Parameters: map[string]*securityhub.ParameterConfiguration{
			"maxCredentialUsageAge": {
				Value: &securityhub.ParameterValue{
					Integer: aws.Int64(15),
				},
				ValueType: aws.String("CUSTOM"),
			},
		},
		SecurityControlId: aws.String("ACM.1"),
	}

	result, err := svc.UpdateSecurityControl(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())
			case securityhub.ErrCodeResourceInUseException:
				fmt.Println(securityhub.ErrCodeResourceInUseException, 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) UpdateSecurityControlRequest added in v1.48.4 

func (c *SecurityHub) UpdateSecurityControlRequest(input *UpdateSecurityControlInput) (req *request.Request, output *UpdateSecurityControlOutput)

UpdateSecurityControlRequest generates a "aws/request.Request" representing the client's request for the UpdateSecurityControl 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 UpdateSecurityControl for more information on using the UpdateSecurityControl 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 UpdateSecurityControlRequest method.
req, resp := client.UpdateSecurityControlRequest(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/UpdateSecurityControl

func (*SecurityHub) UpdateSecurityControlWithContext added in v1.48.4 

func (c *SecurityHub) UpdateSecurityControlWithContext(ctx aws.Context, input *UpdateSecurityControlInput, opts ...request.Option) (*UpdateSecurityControlOutput, error)

UpdateSecurityControlWithContext is the same as UpdateSecurityControl with the addition of the ability to pass a context and additional request options.

See UpdateSecurityControl 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 added in v1.33.14 

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.

  • 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/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())
			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) UpdateSecurityHubConfigurationRequest added in v1.33.14 

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 added in v1.33.14 

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 added in v1.28.3 

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.

  • 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/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())
			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) UpdateStandardsControlRequest added in v1.28.3 

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 added in v1.28.3 

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 SecurityHubPolicy added in v1.48.5 

type SecurityHubPolicy struct {

	// A list that defines which security standards are enabled in the configuration
	// policy.
	EnabledStandardIdentifiers []*string `type:"list"`

	// An object that defines which security controls are enabled in the configuration
	// policy. The enablement status of a control is aligned across all of the enabled
	// standards in an account.
	SecurityControlsConfiguration *SecurityControlsConfiguration `type:"structure"`

	// Indicates whether Security Hub is enabled in the policy.
	ServiceEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

An object that defines how Security Hub is configured. The configuration policy includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).

func (SecurityHubPolicy) GoString added in v1.48.5 

func (s SecurityHubPolicy) GoString() string

GoString returns the string representation.

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

func (*SecurityHubPolicy) SetEnabledStandardIdentifiers added in v1.48.5 

func (s *SecurityHubPolicy) SetEnabledStandardIdentifiers(v []*string) *SecurityHubPolicy

SetEnabledStandardIdentifiers sets the EnabledStandardIdentifiers field's value.

func (*SecurityHubPolicy) SetSecurityControlsConfiguration added in v1.48.5 

func (s *SecurityHubPolicy) SetSecurityControlsConfiguration(v *SecurityControlsConfiguration) *SecurityHubPolicy

SetSecurityControlsConfiguration sets the SecurityControlsConfiguration field's value.

func (*SecurityHubPolicy) SetServiceEnabled added in v1.48.5 

func (s *SecurityHubPolicy) SetServiceEnabled(v bool) *SecurityHubPolicy

SetServiceEnabled sets the ServiceEnabled field's value.

func (SecurityHubPolicy) String added in v1.48.5 

func (s SecurityHubPolicy) String() string

String returns the string representation.

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

func (*SecurityHubPolicy) Validate added in v1.48.5 

func (s *SecurityHubPolicy) Validate() error

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

type SensitiveDataDetections added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *SensitiveDataDetections) SetCount(v int64) *SensitiveDataDetections

SetCount sets the Count field's value.

func (*SensitiveDataDetections) SetOccurrences added in v1.38.0 

func (s *SensitiveDataDetections) SetOccurrences(v *Occurrences) *SensitiveDataDetections

SetOccurrences sets the Occurrences field's value.

func (*SensitiveDataDetections) SetType added in v1.38.0 

func (s *SensitiveDataDetections) SetType(v string) *SensitiveDataDetections

SetType sets the Type field's value.

func (SensitiveDataDetections) String added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

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 added in v1.38.0 

func (s *SensitiveDataResult) SetCategory(v string) *SensitiveDataResult

SetCategory sets the Category field's value.

func (*SensitiveDataResult) SetDetections added in v1.38.0 

func (s *SensitiveDataResult) SetDetections(v []*SensitiveDataDetections) *SensitiveDataResult

SetDetections sets the Detections field's value.

func (*SensitiveDataResult) SetTotalCount added in v1.38.0 

func (s *SensitiveDataResult) SetTotalCount(v int64) *SensitiveDataResult

SetTotalCount sets the TotalCount field's value.

func (SensitiveDataResult) String added in v1.38.0 

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. 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 isn't included in findings. 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 added in v1.29.23 

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 added in v1.31.2 

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 added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

func (s *SeverityUpdate) SetLabel(v string) *SeverityUpdate

SetLabel sets the Label field's value.

func (*SeverityUpdate) SetNormalized added in v1.30.8 

func (s *SeverityUpdate) SetNormalized(v int64) *SeverityUpdate

SetNormalized sets the Normalized field's value.

func (*SeverityUpdate) SetProduct added in v1.30.8 

func (s *SeverityUpdate) SetProduct(v float64) *SeverityUpdate

SetProduct sets the Product field's value.

func (SeverityUpdate) String added in v1.30.8 

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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

func (s *SoftwarePackage) SetArchitecture(v string) *SoftwarePackage

SetArchitecture sets the Architecture field's value.

func (*SoftwarePackage) SetEpoch added in v1.33.0 

func (s *SoftwarePackage) SetEpoch(v string) *SoftwarePackage

SetEpoch sets the Epoch field's value.

func (*SoftwarePackage) SetFilePath added in v1.40.36 

func (s *SoftwarePackage) SetFilePath(v string) *SoftwarePackage

SetFilePath sets the FilePath field's value.

func (*SoftwarePackage) SetFixedInVersion added in v1.44.82 

func (s *SoftwarePackage) SetFixedInVersion(v string) *SoftwarePackage

SetFixedInVersion sets the FixedInVersion field's value.

func (*SoftwarePackage) SetName added in v1.33.0 

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

SetName sets the Name field's value.

func (*SoftwarePackage) SetPackageManager added in v1.40.36 

func (s *SoftwarePackage) SetPackageManager(v string) *SoftwarePackage

SetPackageManager sets the PackageManager field's value.

func (*SoftwarePackage) SetRelease added in v1.33.0 

func (s *SoftwarePackage) SetRelease(v string) *SoftwarePackage

SetRelease sets the Release field's value.

func (*SoftwarePackage) SetRemediation added in v1.44.82 

func (s *SoftwarePackage) SetRemediation(v string) *SoftwarePackage

SetRemediation sets the Remediation field's value.

func (*SoftwarePackage) SetSourceLayerArn added in v1.44.140 

func (s *SoftwarePackage) SetSourceLayerArn(v string) *SoftwarePackage

SetSourceLayerArn sets the SourceLayerArn field's value.

func (*SoftwarePackage) SetSourceLayerHash added in v1.44.140 

func (s *SoftwarePackage) SetSourceLayerHash(v string) *SoftwarePackage

SetSourceLayerHash sets the SourceLayerHash field's value.

func (*SoftwarePackage) SetVersion added in v1.33.0 

func (s *SoftwarePackage) SetVersion(v string) *SoftwarePackage

SetVersion sets the Version field's value.

func (SoftwarePackage) String added in v1.33.0 

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 added in v1.29.3 

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 added in v1.29.3 

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 added in v1.29.3 

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

SetDescription sets the Description field's value.

func (*Standard) SetEnabledByDefault added in v1.29.33 

func (s *Standard) SetEnabledByDefault(v bool) *Standard

SetEnabledByDefault sets the EnabledByDefault field's value.

func (*Standard) SetName added in v1.29.3 

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

SetName sets the Name field's value.

func (*Standard) SetStandardsArn added in v1.29.3 

func (s *Standard) SetStandardsArn(v string) *Standard

SetStandardsArn sets the StandardsArn field's value.

func (*Standard) SetStandardsManagedBy added in v1.44.147 

func (s *Standard) SetStandardsManagedBy(v *StandardsManagedBy) *Standard

SetStandardsManagedBy sets the StandardsManagedBy field's value.

func (Standard) String added in v1.29.3 

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 added in v1.28.3 

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 added in v1.28.3 

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 added in v1.28.3 

func (s *StandardsControl) SetControlId(v string) *StandardsControl

SetControlId sets the ControlId field's value.

func (*StandardsControl) SetControlStatus added in v1.28.3 

func (s *StandardsControl) SetControlStatus(v string) *StandardsControl

SetControlStatus sets the ControlStatus field's value.

func (*StandardsControl) SetControlStatusUpdatedAt added in v1.28.3 

func (s *StandardsControl) SetControlStatusUpdatedAt(v time.Time) *StandardsControl

SetControlStatusUpdatedAt sets the ControlStatusUpdatedAt field's value.

func (*StandardsControl) SetDescription added in v1.28.3 

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

SetDescription sets the Description field's value.

func (*StandardsControl) SetDisabledReason added in v1.28.3 

func (s *StandardsControl) SetDisabledReason(v string) *StandardsControl

SetDisabledReason sets the DisabledReason field's value.

func (*StandardsControl) SetRelatedRequirements added in v1.29.3 

func (s *StandardsControl) SetRelatedRequirements(v []*string) *StandardsControl

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*StandardsControl) SetRemediationUrl added in v1.28.3 

func (s *StandardsControl) SetRemediationUrl(v string) *StandardsControl

SetRemediationUrl sets the RemediationUrl field's value.

func (*StandardsControl) SetSeverityRating added in v1.28.3 

func (s *StandardsControl) SetSeverityRating(v string) *StandardsControl

SetSeverityRating sets the SeverityRating field's value.

func (*StandardsControl) SetStandardsControlArn added in v1.28.3 

func (s *StandardsControl) SetStandardsControlArn(v string) *StandardsControl

SetStandardsControlArn sets the StandardsControlArn field's value.

func (*StandardsControl) SetTitle added in v1.28.3 

func (s *StandardsControl) SetTitle(v string) *StandardsControl

SetTitle sets the Title field's value.

func (StandardsControl) String added in v1.28.3 

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.44.209 

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.44.209 

func (s StandardsControlAssociationDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *StandardsControlAssociationDetail) SetAssociationStatus(v string) *StandardsControlAssociationDetail

SetAssociationStatus sets the AssociationStatus field's value.

func (*StandardsControlAssociationDetail) SetRelatedRequirements added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetRelatedRequirements(v []*string) *StandardsControlAssociationDetail

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*StandardsControlAssociationDetail) SetSecurityControlArn added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetSecurityControlArn(v string) *StandardsControlAssociationDetail

SetSecurityControlArn sets the SecurityControlArn field's value.

func (*StandardsControlAssociationDetail) SetSecurityControlId added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetSecurityControlId(v string) *StandardsControlAssociationDetail

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationDetail) SetStandardsArn added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetStandardsArn(v string) *StandardsControlAssociationDetail

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsControlAssociationDetail) SetStandardsControlArns added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetStandardsControlArns(v []*string) *StandardsControlAssociationDetail

SetStandardsControlArns sets the StandardsControlArns field's value.

func (*StandardsControlAssociationDetail) SetStandardsControlDescription added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetStandardsControlDescription(v string) *StandardsControlAssociationDetail

SetStandardsControlDescription sets the StandardsControlDescription field's value.

func (*StandardsControlAssociationDetail) SetStandardsControlTitle added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetStandardsControlTitle(v string) *StandardsControlAssociationDetail

SetStandardsControlTitle sets the StandardsControlTitle field's value.

func (*StandardsControlAssociationDetail) SetUpdatedAt added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetUpdatedAt(v time.Time) *StandardsControlAssociationDetail

SetUpdatedAt sets the UpdatedAt field's value.

func (*StandardsControlAssociationDetail) SetUpdatedReason added in v1.44.209 

func (s *StandardsControlAssociationDetail) SetUpdatedReason(v string) *StandardsControlAssociationDetail

SetUpdatedReason sets the UpdatedReason field's value.

func (StandardsControlAssociationDetail) String added in v1.44.209 

func (s StandardsControlAssociationDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s StandardsControlAssociationId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *StandardsControlAssociationId) SetSecurityControlId(v string) *StandardsControlAssociationId

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationId) SetStandardsArn added in v1.44.209 

func (s *StandardsControlAssociationId) SetStandardsArn(v string) *StandardsControlAssociationId

SetStandardsArn sets the StandardsArn field's value.

func (StandardsControlAssociationId) String added in v1.44.209 

func (s StandardsControlAssociationId) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *StandardsControlAssociationId) Validate() error

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

type StandardsControlAssociationSummary added in v1.44.209 

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 a 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.44.209 

func (s StandardsControlAssociationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *StandardsControlAssociationSummary) SetAssociationStatus(v string) *StandardsControlAssociationSummary

SetAssociationStatus sets the AssociationStatus field's value.

func (*StandardsControlAssociationSummary) SetRelatedRequirements added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetRelatedRequirements(v []*string) *StandardsControlAssociationSummary

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*StandardsControlAssociationSummary) SetSecurityControlArn added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetSecurityControlArn(v string) *StandardsControlAssociationSummary

SetSecurityControlArn sets the SecurityControlArn field's value.

func (*StandardsControlAssociationSummary) SetSecurityControlId added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetSecurityControlId(v string) *StandardsControlAssociationSummary

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationSummary) SetStandardsArn added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetStandardsArn(v string) *StandardsControlAssociationSummary

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsControlAssociationSummary) SetStandardsControlDescription added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetStandardsControlDescription(v string) *StandardsControlAssociationSummary

SetStandardsControlDescription sets the StandardsControlDescription field's value.

func (*StandardsControlAssociationSummary) SetStandardsControlTitle added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetStandardsControlTitle(v string) *StandardsControlAssociationSummary

SetStandardsControlTitle sets the StandardsControlTitle field's value.

func (*StandardsControlAssociationSummary) SetUpdatedAt added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetUpdatedAt(v time.Time) *StandardsControlAssociationSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (*StandardsControlAssociationSummary) SetUpdatedReason added in v1.44.209 

func (s *StandardsControlAssociationSummary) SetUpdatedReason(v string) *StandardsControlAssociationSummary

SetUpdatedReason sets the UpdatedReason field's value.

func (StandardsControlAssociationSummary) String added in v1.44.209 

func (s StandardsControlAssociationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s StandardsControlAssociationUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *StandardsControlAssociationUpdate) SetAssociationStatus(v string) *StandardsControlAssociationUpdate

SetAssociationStatus sets the AssociationStatus field's value.

func (*StandardsControlAssociationUpdate) SetSecurityControlId added in v1.44.209 

func (s *StandardsControlAssociationUpdate) SetSecurityControlId(v string) *StandardsControlAssociationUpdate

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationUpdate) SetStandardsArn added in v1.44.209 

func (s *StandardsControlAssociationUpdate) SetStandardsArn(v string) *StandardsControlAssociationUpdate

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsControlAssociationUpdate) SetUpdatedReason added in v1.44.209 

func (s *StandardsControlAssociationUpdate) SetUpdatedReason(v string) *StandardsControlAssociationUpdate

SetUpdatedReason sets the UpdatedReason field's value.

func (StandardsControlAssociationUpdate) String added in v1.44.209 

func (s StandardsControlAssociationUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *StandardsControlAssociationUpdate) Validate() error

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

type StandardsManagedBy added in v1.44.147 

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.44.147 

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.44.147 

func (s *StandardsManagedBy) SetCompany(v string) *StandardsManagedBy

SetCompany sets the Company field's value.

func (*StandardsManagedBy) SetProduct added in v1.44.147 

func (s *StandardsManagedBy) SetProduct(v string) *StandardsManagedBy

SetProduct sets the Product field's value.

func (StandardsManagedBy) String added in v1.44.147 

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.24 

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.24 

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.24 

func (s *StandardsStatusReason) SetStatusReasonCode(v string) *StandardsStatusReason

SetStatusReasonCode sets the StatusReasonCode field's value.

func (StandardsStatusReason) String added in v1.42.24 

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.24 

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 

func (s *StandardsSubscriptionRequest) SetStandardsArn(v string) *StandardsSubscriptionRequest

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsSubscriptionRequest) SetStandardsInput 

func (s *StandardsSubscriptionRequest) SetStandardsInput(v map[string]*string) *StandardsSubscriptionRequest

SetStandardsInput sets the StandardsInput field's value.

func (StandardsSubscriptionRequest) String 

func (s StandardsSubscriptionRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 StartConfigurationPolicyAssociationInput added in v1.48.5 

type StartConfigurationPolicyAssociationInput struct {

	// The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
	// the configuration policy.
	//
	// ConfigurationPolicyIdentifier is a required field
	ConfigurationPolicyIdentifier *string `type:"string" required:"true"`

	// The identifier of the target account, organizational unit, or the root to
	// associate with the specified configuration.
	//
	// Target is a required field
	Target *Target `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartConfigurationPolicyAssociationInput) GoString added in v1.48.5 

func (s StartConfigurationPolicyAssociationInput) GoString() string

GoString returns the string representation.

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

func (*StartConfigurationPolicyAssociationInput) SetConfigurationPolicyIdentifier added in v1.48.5 

func (s *StartConfigurationPolicyAssociationInput) SetConfigurationPolicyIdentifier(v string) *StartConfigurationPolicyAssociationInput

SetConfigurationPolicyIdentifier sets the ConfigurationPolicyIdentifier field's value.

func (*StartConfigurationPolicyAssociationInput) SetTarget added in v1.48.5 

func (s *StartConfigurationPolicyAssociationInput) SetTarget(v *Target) *StartConfigurationPolicyAssociationInput

SetTarget sets the Target field's value.

func (StartConfigurationPolicyAssociationInput) String added in v1.48.5 

func (s StartConfigurationPolicyAssociationInput) String() string

String returns the string representation.

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

func (*StartConfigurationPolicyAssociationInput) Validate added in v1.48.5 

func (s *StartConfigurationPolicyAssociationInput) Validate() error

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

type StartConfigurationPolicyAssociationOutput added in v1.48.5 

type StartConfigurationPolicyAssociationOutput struct {

	// The current status of the association between the specified target and the
	// configuration.
	AssociationStatus *string `type:"string" enum:"ConfigurationPolicyAssociationStatus"`

	// An explanation for a FAILED value for AssociationStatus.
	AssociationStatusMessage *string `type:"string"`

	// Indicates whether the association between the specified target and the configuration
	// was directly applied by the Security Hub delegated administrator or inherited
	// from a parent.
	AssociationType *string `type:"string" enum:"AssociationType"`

	// The UUID of the configuration policy.
	ConfigurationPolicyId *string `type:"string"`

	// The identifier of the target account, organizational unit, or the organization
	// root with which the configuration is associated.
	TargetId *string `type:"string"`

	// Indicates whether the target is an Amazon Web Services account, organizational
	// unit, or the organization root.
	TargetType *string `type:"string" enum:"TargetType"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// association was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (StartConfigurationPolicyAssociationOutput) GoString added in v1.48.5 

func (s StartConfigurationPolicyAssociationOutput) GoString() string

GoString returns the string representation.

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

func (*StartConfigurationPolicyAssociationOutput) SetAssociationStatus added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetAssociationStatus(v string) *StartConfigurationPolicyAssociationOutput

SetAssociationStatus sets the AssociationStatus field's value.

func (*StartConfigurationPolicyAssociationOutput) SetAssociationStatusMessage added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetAssociationStatusMessage(v string) *StartConfigurationPolicyAssociationOutput

SetAssociationStatusMessage sets the AssociationStatusMessage field's value.

func (*StartConfigurationPolicyAssociationOutput) SetAssociationType added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetAssociationType(v string) *StartConfigurationPolicyAssociationOutput

SetAssociationType sets the AssociationType field's value.

func (*StartConfigurationPolicyAssociationOutput) SetConfigurationPolicyId added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetConfigurationPolicyId(v string) *StartConfigurationPolicyAssociationOutput

SetConfigurationPolicyId sets the ConfigurationPolicyId field's value.

func (*StartConfigurationPolicyAssociationOutput) SetTargetId added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetTargetId(v string) *StartConfigurationPolicyAssociationOutput

SetTargetId sets the TargetId field's value.

func (*StartConfigurationPolicyAssociationOutput) SetTargetType added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetTargetType(v string) *StartConfigurationPolicyAssociationOutput

SetTargetType sets the TargetType field's value.

func (*StartConfigurationPolicyAssociationOutput) SetUpdatedAt added in v1.48.5 

func (s *StartConfigurationPolicyAssociationOutput) SetUpdatedAt(v time.Time) *StartConfigurationPolicyAssociationOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (StartConfigurationPolicyAssociationOutput) String added in v1.48.5 

func (s StartConfigurationPolicyAssociationOutput) String() string

String returns the string representation.

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

type StartConfigurationPolicyDisassociationInput added in v1.48.5 

type StartConfigurationPolicyDisassociationInput struct {

	// The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
	// the configuration policy.
	//
	// ConfigurationPolicyIdentifier is a required field
	ConfigurationPolicyIdentifier *string `type:"string" required:"true"`

	// The identifier of the target account, organizational unit, or the root to
	// disassociate from the specified configuration.
	Target *Target `type:"structure"`
	// contains filtered or unexported fields
}

func (StartConfigurationPolicyDisassociationInput) GoString added in v1.48.5 

func (s StartConfigurationPolicyDisassociationInput) GoString() string

GoString returns the string representation.

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

func (*StartConfigurationPolicyDisassociationInput) SetConfigurationPolicyIdentifier added in v1.48.5 

func (s *StartConfigurationPolicyDisassociationInput) SetConfigurationPolicyIdentifier(v string) *StartConfigurationPolicyDisassociationInput

SetConfigurationPolicyIdentifier sets the ConfigurationPolicyIdentifier field's value.

func (*StartConfigurationPolicyDisassociationInput) SetTarget added in v1.48.5 

func (s *StartConfigurationPolicyDisassociationInput) SetTarget(v *Target) *StartConfigurationPolicyDisassociationInput

SetTarget sets the Target field's value.

func (StartConfigurationPolicyDisassociationInput) String added in v1.48.5 

func (s StartConfigurationPolicyDisassociationInput) String() string

String returns the string representation.

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

func (*StartConfigurationPolicyDisassociationInput) Validate added in v1.48.5 

func (s *StartConfigurationPolicyDisassociationInput) Validate() error

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

type StartConfigurationPolicyDisassociationOutput added in v1.48.5 

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

func (StartConfigurationPolicyDisassociationOutput) GoString added in v1.48.5 

func (s StartConfigurationPolicyDisassociationOutput) GoString() string

GoString returns the string representation.

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

func (StartConfigurationPolicyDisassociationOutput) String added in v1.48.5 

func (s StartConfigurationPolicyDisassociationOutput) String() string

String returns the string representation.

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

type StatelessCustomActionDefinition added in v1.42.24 

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.24 

func (s StatelessCustomActionDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *StatelessCustomActionDefinition) SetPublishMetricAction(v *StatelessCustomPublishMetricAction) *StatelessCustomActionDefinition

SetPublishMetricAction sets the PublishMetricAction field's value.

func (StatelessCustomActionDefinition) String added in v1.42.24 

func (s StatelessCustomActionDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s StatelessCustomPublishMetricAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *StatelessCustomPublishMetricAction) SetDimensions(v []*StatelessCustomPublishMetricActionDimension) *StatelessCustomPublishMetricAction

SetDimensions sets the Dimensions field's value.

func (StatelessCustomPublishMetricAction) String added in v1.42.24 

func (s StatelessCustomPublishMetricAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

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.24 

func (s StatelessCustomPublishMetricActionDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.24 

func (s *StatelessCustomPublishMetricActionDimension) SetValue(v string) *StatelessCustomPublishMetricActionDimension

SetValue sets the Value field's value.

func (StatelessCustomPublishMetricActionDimension) String added in v1.42.24 

func (s StatelessCustomPublishMetricActionDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.31.2 

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 added in v1.31.2 

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 added in v1.31.2 

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

SetDescription sets the Description field's value.

func (*StatusReason) SetReasonCode added in v1.31.2 

func (s *StatusReason) SetReasonCode(v string) *StatusReason

SetReasonCode sets the ReasonCode field's value.

func (StatusReason) String added in v1.31.2 

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 added in v1.31.2 

func (s *StatusReason) Validate() error

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

type StringConfigurationOptions added in v1.48.4 

type StringConfigurationOptions struct {

	// The Security Hub default value for a control parameter that is a string.
	DefaultValue *string `type:"string"`

	// The description of the RE2 regular expression.
	ExpressionDescription *string `type:"string"`

	// An RE2 regular expression that Security Hub uses to validate a user-provided
	// control parameter string.
	Re2Expression *string `type:"string"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is a string.

func (StringConfigurationOptions) GoString added in v1.48.4 

func (s StringConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*StringConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *StringConfigurationOptions) SetDefaultValue(v string) *StringConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (*StringConfigurationOptions) SetExpressionDescription added in v1.48.4 

func (s *StringConfigurationOptions) SetExpressionDescription(v string) *StringConfigurationOptions

SetExpressionDescription sets the ExpressionDescription field's value.

func (*StringConfigurationOptions) SetRe2Expression added in v1.48.4 

func (s *StringConfigurationOptions) SetRe2Expression(v string) *StringConfigurationOptions

SetRe2Expression sets the Re2Expression field's value.

func (StringConfigurationOptions) String added in v1.48.4 

func (s StringConfigurationOptions) String() string

String returns the string representation.

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

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 StringListConfigurationOptions added in v1.48.4 

type StringListConfigurationOptions struct {

	// The Security Hub default value for a control parameter that is a list of
	// strings.
	DefaultValue []*string `type:"list"`

	// The description of the RE2 regular expression.
	ExpressionDescription *string `type:"string"`

	// The maximum number of list items that a string list control parameter can
	// accept.
	MaxItems *int64 `type:"integer"`

	// An RE2 regular expression that Security Hub uses to validate a user-provided
	// list of strings for a control parameter.
	Re2Expression *string `type:"string"`
	// contains filtered or unexported fields
}

The options for customizing a security control parameter that is a list of strings.

func (StringListConfigurationOptions) GoString added in v1.48.4 

func (s StringListConfigurationOptions) GoString() string

GoString returns the string representation.

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

func (*StringListConfigurationOptions) SetDefaultValue added in v1.48.4 

func (s *StringListConfigurationOptions) SetDefaultValue(v []*string) *StringListConfigurationOptions

SetDefaultValue sets the DefaultValue field's value.

func (*StringListConfigurationOptions) SetExpressionDescription added in v1.48.4 

func (s *StringListConfigurationOptions) SetExpressionDescription(v string) *StringListConfigurationOptions

SetExpressionDescription sets the ExpressionDescription field's value.

func (*StringListConfigurationOptions) SetMaxItems added in v1.48.4 

func (s *StringListConfigurationOptions) SetMaxItems(v int64) *StringListConfigurationOptions

SetMaxItems sets the MaxItems field's value.

func (*StringListConfigurationOptions) SetRe2Expression added in v1.48.4 

func (s *StringListConfigurationOptions) SetRe2Expression(v string) *StringListConfigurationOptions

SetRe2Expression sets the Re2Expression field's value.

func (StringListConfigurationOptions) String added in v1.48.4 

func (s StringListConfigurationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.20.7 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.20.7 

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 added in v1.20.7 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.20.7 

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

func (TagResourceOutput) GoString added in v1.20.7 

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 added in v1.20.7 

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 Target added in v1.48.5 

type Target struct {

	// The Amazon Web Services account ID of the target account.
	AccountId *string `type:"string"`

	// The organizational unit ID of the target organizational unit.
	OrganizationalUnitId *string `type:"string"`

	// The ID of the organization root.
	RootId *string `type:"string"`
	// contains filtered or unexported fields
}

The target account, organizational unit, or the root that is associated with an Security Hub configuration. The configuration can be a configuration policy or self-managed behavior.

func (Target) GoString added in v1.48.5 

func (s Target) GoString() string

GoString returns the string representation.

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

func (*Target) SetAccountId added in v1.48.5 

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

SetAccountId sets the AccountId field's value.

func (*Target) SetOrganizationalUnitId added in v1.48.5 

func (s *Target) SetOrganizationalUnitId(v string) *Target

SetOrganizationalUnitId sets the OrganizationalUnitId field's value.

func (*Target) SetRootId added in v1.48.5 

func (s *Target) SetRootId(v string) *Target

SetRootId sets the RootId field's value.

func (Target) String added in v1.48.5 

func (s Target) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *Threat) SetFilePaths(v []*FilePaths) *Threat

SetFilePaths sets the FilePaths field's value.

func (*Threat) SetItemCount added in v1.44.36 

func (s *Threat) SetItemCount(v int64) *Threat

SetItemCount sets the ItemCount field's value.

func (*Threat) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (*Threat) SetSeverity added in v1.44.36 

func (s *Threat) SetSeverity(v string) *Threat

SetSeverity sets the Severity field's value.

func (Threat) String added in v1.44.36 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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 

func (s *ThreatIntelIndicator) SetCategory(v string) *ThreatIntelIndicator

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 

func (s *ThreatIntelIndicator) SetSource(v string) *ThreatIntelIndicator

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 

func (s *ThreatIntelIndicator) SetType(v string) *ThreatIntelIndicator

SetType sets the Type field's value.

func (*ThreatIntelIndicator) SetValue 

func (s *ThreatIntelIndicator) SetValue(v string) *ThreatIntelIndicator

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.44.282 

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.44.282 

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.44.282 

func (s *UnprocessedAutomationRule) SetErrorCode(v int64) *UnprocessedAutomationRule

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedAutomationRule) SetErrorMessage added in v1.44.282 

func (s *UnprocessedAutomationRule) SetErrorMessage(v string) *UnprocessedAutomationRule

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedAutomationRule) SetRuleArn added in v1.44.282 

func (s *UnprocessedAutomationRule) SetRuleArn(v string) *UnprocessedAutomationRule

SetRuleArn sets the RuleArn field's value.

func (UnprocessedAutomationRule) String added in v1.44.282 

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 UnprocessedConfigurationPolicyAssociation added in v1.48.5 

type UnprocessedConfigurationPolicyAssociation struct {

	// Configuration policy association identifiers that were specified in a BatchGetConfigurationPolicyAssociations
	// request but couldn’t be processed due to an error.
	ConfigurationPolicyAssociationIdentifiers *ConfigurationPolicyAssociation `type:"structure"`

	// An HTTP status code that identifies why the configuration policy association
	// failed.
	ErrorCode *string `type:"string"`

	// A string that identifies why the configuration policy association failed.
	ErrorReason *string `type:"string"`
	// contains filtered or unexported fields
}

An array of configuration policy associations, one for each configuration policy association identifier, that was specified in a BatchGetConfigurationPolicyAssociations request but couldn’t be processed due to an error.

func (UnprocessedConfigurationPolicyAssociation) GoString added in v1.48.5 

func (s UnprocessedConfigurationPolicyAssociation) GoString() string

GoString returns the string representation.

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

func (*UnprocessedConfigurationPolicyAssociation) SetConfigurationPolicyAssociationIdentifiers added in v1.48.5 

func (s *UnprocessedConfigurationPolicyAssociation) SetConfigurationPolicyAssociationIdentifiers(v *ConfigurationPolicyAssociation) *UnprocessedConfigurationPolicyAssociation

SetConfigurationPolicyAssociationIdentifiers sets the ConfigurationPolicyAssociationIdentifiers field's value.

func (*UnprocessedConfigurationPolicyAssociation) SetErrorCode added in v1.48.5 

func (s *UnprocessedConfigurationPolicyAssociation) SetErrorCode(v string) *UnprocessedConfigurationPolicyAssociation

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedConfigurationPolicyAssociation) SetErrorReason added in v1.48.5 

func (s *UnprocessedConfigurationPolicyAssociation) SetErrorReason(v string) *UnprocessedConfigurationPolicyAssociation

SetErrorReason sets the ErrorReason field's value.

func (UnprocessedConfigurationPolicyAssociation) String added in v1.48.5 

func (s UnprocessedConfigurationPolicyAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

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.44.209 

func (s *UnprocessedSecurityControl) SetErrorCode(v string) *UnprocessedSecurityControl

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedSecurityControl) SetErrorReason added in v1.44.209 

func (s *UnprocessedSecurityControl) SetErrorReason(v string) *UnprocessedSecurityControl

SetErrorReason sets the ErrorReason field's value.

func (*UnprocessedSecurityControl) SetSecurityControlId added in v1.44.209 

func (s *UnprocessedSecurityControl) SetSecurityControlId(v string) *UnprocessedSecurityControl

SetSecurityControlId sets the SecurityControlId field's value.

func (UnprocessedSecurityControl) String added in v1.44.209 

func (s UnprocessedSecurityControl) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s UnprocessedStandardsControlAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *UnprocessedStandardsControlAssociation) SetErrorCode(v string) *UnprocessedStandardsControlAssociation

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedStandardsControlAssociation) SetErrorReason added in v1.44.209 

func (s *UnprocessedStandardsControlAssociation) SetErrorReason(v string) *UnprocessedStandardsControlAssociation

SetErrorReason sets the ErrorReason field's value.

func (*UnprocessedStandardsControlAssociation) SetStandardsControlAssociationId added in v1.44.209 

func (s *UnprocessedStandardsControlAssociation) SetStandardsControlAssociationId(v *StandardsControlAssociationId) *UnprocessedStandardsControlAssociation

SetStandardsControlAssociationId sets the StandardsControlAssociationId field's value.

func (UnprocessedStandardsControlAssociation) String added in v1.44.209 

func (s UnprocessedStandardsControlAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

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.44.209 

func (s UnprocessedStandardsControlAssociationUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.209 

func (s *UnprocessedStandardsControlAssociationUpdate) SetErrorCode(v string) *UnprocessedStandardsControlAssociationUpdate

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedStandardsControlAssociationUpdate) SetErrorReason added in v1.44.209 

func (s *UnprocessedStandardsControlAssociationUpdate) SetErrorReason(v string) *UnprocessedStandardsControlAssociationUpdate

SetErrorReason sets the ErrorReason field's value.

func (*UnprocessedStandardsControlAssociationUpdate) SetStandardsControlAssociationUpdate added in v1.44.209 

func (s *UnprocessedStandardsControlAssociationUpdate) SetStandardsControlAssociationUpdate(v *StandardsControlAssociationUpdate) *UnprocessedStandardsControlAssociationUpdate

SetStandardsControlAssociationUpdate sets the StandardsControlAssociationUpdate field's value.

func (UnprocessedStandardsControlAssociationUpdate) String added in v1.44.209 

func (s UnprocessedStandardsControlAssociationUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.20.7 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.20.7 

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 added in v1.20.7 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.20.7 

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

func (UntagResourceOutput) GoString added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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 added in v1.20.7 

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

SetActionTargetArn sets the ActionTargetArn field's value.

func (*UpdateActionTargetInput) SetDescription added in v1.20.7 

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

SetDescription sets the Description field's value.

func (*UpdateActionTargetInput) SetName added in v1.20.7 

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

SetName sets the Name field's value.

func (UpdateActionTargetInput) String added in v1.20.7 

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 added in v1.20.7 

func (s *UpdateActionTargetInput) Validate() error

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

type UpdateActionTargetOutput added in v1.20.7 

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

func (UpdateActionTargetOutput) GoString added in v1.20.7 

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 added in v1.20.7 

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.44.282 

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.44.282 

func (s UpdateAutomationRulesRequestItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *UpdateAutomationRulesRequestItem) SetActions(v []*AutomationRulesAction) *UpdateAutomationRulesRequestItem

SetActions sets the Actions field's value.

func (*UpdateAutomationRulesRequestItem) SetCriteria added in v1.44.282 

func (s *UpdateAutomationRulesRequestItem) SetCriteria(v *AutomationRulesFindingFilters) *UpdateAutomationRulesRequestItem

SetCriteria sets the Criteria field's value.

func (*UpdateAutomationRulesRequestItem) SetDescription added in v1.44.282 

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

SetDescription sets the Description field's value.

func (*UpdateAutomationRulesRequestItem) SetIsTerminal added in v1.44.282 

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

SetIsTerminal sets the IsTerminal field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleArn added in v1.44.282 

func (s *UpdateAutomationRulesRequestItem) SetRuleArn(v string) *UpdateAutomationRulesRequestItem

SetRuleArn sets the RuleArn field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleName added in v1.44.282 

func (s *UpdateAutomationRulesRequestItem) SetRuleName(v string) *UpdateAutomationRulesRequestItem

SetRuleName sets the RuleName field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleOrder added in v1.44.282 

func (s *UpdateAutomationRulesRequestItem) SetRuleOrder(v int64) *UpdateAutomationRulesRequestItem

SetRuleOrder sets the RuleOrder field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleStatus added in v1.44.282 

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

SetRuleStatus sets the RuleStatus field's value.

func (UpdateAutomationRulesRequestItem) String added in v1.44.282 

func (s UpdateAutomationRulesRequestItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.282 

func (s *UpdateAutomationRulesRequestItem) Validate() error

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

type UpdateConfigurationPolicyInput added in v1.48.5 

type UpdateConfigurationPolicyInput struct {

	// An object that defines how Security Hub is configured. It includes whether
	// Security Hub is enabled or disabled, a list of enabled security standards,
	// a list of enabled or disabled security controls, and a list of custom parameter
	// values for specified controls. If you provide a list of security controls
	// that are enabled in the configuration policy, Security Hub disables all other
	// controls (including newly released controls). If you provide a list of security
	// controls that are disabled in the configuration policy, Security Hub enables
	// all other controls (including newly released controls).
	//
	// When updating a configuration policy, provide a complete list of standards
	// that you want to enable and a complete list of controls that you want to
	// enable or disable. The updated configuration replaces the current configuration.
	ConfigurationPolicy *Policy `type:"structure"`

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

	// The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
	// the configuration policy.
	//
	// Identifier is a required field
	Identifier *string `location:"uri" locationName:"Identifier" type:"string" required:"true"`

	// The name of the configuration policy. Alphanumeric characters and the following
	// ASCII characters are permitted: -, ., !, *, /.
	Name *string `type:"string"`

	// The reason for updating the configuration policy.
	UpdatedReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateConfigurationPolicyInput) GoString added in v1.48.5 

func (s UpdateConfigurationPolicyInput) GoString() string

GoString returns the string representation.

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

func (*UpdateConfigurationPolicyInput) SetConfigurationPolicy added in v1.48.5 

func (s *UpdateConfigurationPolicyInput) SetConfigurationPolicy(v *Policy) *UpdateConfigurationPolicyInput

SetConfigurationPolicy sets the ConfigurationPolicy field's value.

func (*UpdateConfigurationPolicyInput) SetDescription added in v1.48.5 

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

SetDescription sets the Description field's value.

func (*UpdateConfigurationPolicyInput) SetIdentifier added in v1.48.5 

func (s *UpdateConfigurationPolicyInput) SetIdentifier(v string) *UpdateConfigurationPolicyInput

SetIdentifier sets the Identifier field's value.

func (*UpdateConfigurationPolicyInput) SetName added in v1.48.5 

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

SetName sets the Name field's value.

func (*UpdateConfigurationPolicyInput) SetUpdatedReason added in v1.48.5 

func (s *UpdateConfigurationPolicyInput) SetUpdatedReason(v string) *UpdateConfigurationPolicyInput

SetUpdatedReason sets the UpdatedReason field's value.

func (UpdateConfigurationPolicyInput) String added in v1.48.5 

func (s UpdateConfigurationPolicyInput) String() string

String returns the string representation.

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

func (*UpdateConfigurationPolicyInput) Validate added in v1.48.5 

func (s *UpdateConfigurationPolicyInput) Validate() error

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

type UpdateConfigurationPolicyOutput added in v1.48.5 

type UpdateConfigurationPolicyOutput struct {

	// The ARN of the configuration policy.
	Arn *string `type:"string"`

	// An object that defines how Security Hub is configured. It includes whether
	// Security Hub is enabled or disabled, a list of enabled security standards,
	// a list of enabled or disabled security controls, and a list of custom parameter
	// values for specified controls. If the request included a list of security
	// controls that are enabled in the configuration policy, Security Hub disables
	// all other controls (including newly released controls). If the request included
	// a list of security controls that are disabled in the configuration policy,
	// Security Hub enables all other controls (including newly released controls).
	ConfigurationPolicy *Policy `type:"structure"`

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

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

	// The UUID of the configuration policy.
	Id *string `type:"string"`

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

	// The date and time, in UTC and ISO 8601 format, that the configuration policy
	// was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (UpdateConfigurationPolicyOutput) GoString added in v1.48.5 

func (s UpdateConfigurationPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*UpdateConfigurationPolicyOutput) SetArn added in v1.48.5 

func (s *UpdateConfigurationPolicyOutput) SetArn(v string) *UpdateConfigurationPolicyOutput

SetArn sets the Arn field's value.

func (*UpdateConfigurationPolicyOutput) SetConfigurationPolicy added in v1.48.5 

func (s *UpdateConfigurationPolicyOutput) SetConfigurationPolicy(v *Policy) *UpdateConfigurationPolicyOutput

SetConfigurationPolicy sets the ConfigurationPolicy field's value.

func (*UpdateConfigurationPolicyOutput) SetCreatedAt added in v1.48.5 

func (s *UpdateConfigurationPolicyOutput) SetCreatedAt(v time.Time) *UpdateConfigurationPolicyOutput

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateConfigurationPolicyOutput) SetDescription added in v1.48.5 

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

SetDescription sets the Description field's value.

func (*UpdateConfigurationPolicyOutput) SetId added in v1.48.5 

func (s *UpdateConfigurationPolicyOutput) SetId(v string) *UpdateConfigurationPolicyOutput

SetId sets the Id field's value.

func (*UpdateConfigurationPolicyOutput) SetName added in v1.48.5 

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

SetName sets the Name field's value.

func (*UpdateConfigurationPolicyOutput) SetUpdatedAt added in v1.48.5 

func (s *UpdateConfigurationPolicyOutput) SetUpdatedAt(v time.Time) *UpdateConfigurationPolicyOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (UpdateConfigurationPolicyOutput) String added in v1.48.5 

func (s UpdateConfigurationPolicyOutput) String() string

String returns the string representation.

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

type UpdateFindingAggregatorInput added in v1.41.7 

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 added in v1.41.7 

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 added in v1.41.7 

func (s *UpdateFindingAggregatorInput) SetFindingAggregatorArn(v string) *UpdateFindingAggregatorInput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*UpdateFindingAggregatorInput) SetRegionLinkingMode added in v1.41.7 

func (s *UpdateFindingAggregatorInput) SetRegionLinkingMode(v string) *UpdateFindingAggregatorInput

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*UpdateFindingAggregatorInput) SetRegions added in v1.41.7 

func (s *UpdateFindingAggregatorInput) SetRegions(v []*string) *UpdateFindingAggregatorInput

SetRegions sets the Regions field's value.

func (UpdateFindingAggregatorInput) String added in v1.41.7 

func (s UpdateFindingAggregatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s *UpdateFindingAggregatorInput) Validate() error

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

type UpdateFindingAggregatorOutput added in v1.41.7 

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 added in v1.41.7 

func (s UpdateFindingAggregatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.41.7 

func (s *UpdateFindingAggregatorOutput) SetFindingAggregationRegion(v string) *UpdateFindingAggregatorOutput

SetFindingAggregationRegion sets the FindingAggregationRegion field's value.

func (*UpdateFindingAggregatorOutput) SetFindingAggregatorArn added in v1.41.7 

func (s *UpdateFindingAggregatorOutput) SetFindingAggregatorArn(v string) *UpdateFindingAggregatorOutput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*UpdateFindingAggregatorOutput) SetRegionLinkingMode added in v1.41.7 

func (s *UpdateFindingAggregatorOutput) SetRegionLinkingMode(v string) *UpdateFindingAggregatorOutput

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*UpdateFindingAggregatorOutput) SetRegions added in v1.41.7 

func (s *UpdateFindingAggregatorOutput) SetRegions(v []*string) *UpdateFindingAggregatorOutput

SetRegions sets the Regions field's value.

func (UpdateFindingAggregatorOutput) String added in v1.41.7 

func (s UpdateFindingAggregatorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 

func (s *UpdateFindingsInput) SetFilters(v *AwsSecurityFindingFilters) *UpdateFindingsInput

SetFilters sets the Filters field's value.

func (*UpdateFindingsInput) SetNote 

func (s *UpdateFindingsInput) SetNote(v *NoteUpdate) *UpdateFindingsInput

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 

func (s *UpdateInsightInput) SetFilters(v *AwsSecurityFindingFilters) *UpdateInsightInput

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 

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

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 added in v1.35.34 

type UpdateOrganizationConfigurationInput struct {

	// Whether to automatically enable Security Hub in new member accounts when
	// they join the organization.
	//
	// If set to true, then Security Hub is automatically enabled in new accounts.
	// If set to false, then Security Hub isn't enabled in new accounts automatically.
	// The default value is false.
	//
	// If the ConfigurationType of your organization is set to CENTRAL, then this
	// field is set to false and can't be changed in the home Region and linked
	// Regions. However, in that case, the delegated administrator can create a
	// configuration policy in which Security Hub is enabled and associate the policy
	// with new organization accounts.
	//
	// 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)
	// in new member accounts when they join 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.
	//
	// If the ConfigurationType of your organization is set to CENTRAL, then this
	// field is set to NONE and can't be changed in the home Region and linked Regions.
	// However, in that case, the delegated administrator can create a configuration
	// policy in which specific security standards are enabled and associate the
	// policy with new organization accounts.
	AutoEnableStandards *string `type:"string" enum:"AutoEnableStandards"`

	// Provides information about the way an organization is configured in Security
	// Hub.
	OrganizationConfiguration *OrganizationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateOrganizationConfigurationInput) GoString added in v1.35.34 

func (s UpdateOrganizationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *UpdateOrganizationConfigurationInput) SetAutoEnable(v bool) *UpdateOrganizationConfigurationInput

SetAutoEnable sets the AutoEnable field's value.

func (*UpdateOrganizationConfigurationInput) SetAutoEnableStandards added in v1.44.0 

func (s *UpdateOrganizationConfigurationInput) SetAutoEnableStandards(v string) *UpdateOrganizationConfigurationInput

SetAutoEnableStandards sets the AutoEnableStandards field's value.

func (*UpdateOrganizationConfigurationInput) SetOrganizationConfiguration added in v1.48.5 

func (s *UpdateOrganizationConfigurationInput) SetOrganizationConfiguration(v *OrganizationConfiguration) *UpdateOrganizationConfigurationInput

SetOrganizationConfiguration sets the OrganizationConfiguration field's value.

func (UpdateOrganizationConfigurationInput) String added in v1.35.34 

func (s UpdateOrganizationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s *UpdateOrganizationConfigurationInput) Validate() error

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

type UpdateOrganizationConfigurationOutput added in v1.35.34 

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

func (UpdateOrganizationConfigurationOutput) GoString added in v1.35.34 

func (s UpdateOrganizationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.35.34 

func (s UpdateOrganizationConfigurationOutput) String() string

String returns the string representation.

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

type UpdateSecurityControlInput added in v1.48.4 

type UpdateSecurityControlInput struct {

	// The most recent reason for updating the properties of the security control.
	// This field accepts alphanumeric characters in addition to white spaces, dashes,
	// and underscores.
	LastUpdateReason *string `type:"string"`

	// An object that specifies which security control parameters to update.
	//
	// Parameters is a required field
	Parameters map[string]*ParameterConfiguration `type:"map" required:"true"`

	// The Amazon Resource Name (ARN) or ID of the control to update.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSecurityControlInput) GoString added in v1.48.4 

func (s UpdateSecurityControlInput) GoString() string

GoString returns the string representation.

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

func (*UpdateSecurityControlInput) SetLastUpdateReason added in v1.48.4 

func (s *UpdateSecurityControlInput) SetLastUpdateReason(v string) *UpdateSecurityControlInput

SetLastUpdateReason sets the LastUpdateReason field's value.

func (*UpdateSecurityControlInput) SetParameters added in v1.48.4 

func (s *UpdateSecurityControlInput) SetParameters(v map[string]*ParameterConfiguration) *UpdateSecurityControlInput

SetParameters sets the Parameters field's value.

func (*UpdateSecurityControlInput) SetSecurityControlId added in v1.48.4 

func (s *UpdateSecurityControlInput) SetSecurityControlId(v string) *UpdateSecurityControlInput

SetSecurityControlId sets the SecurityControlId field's value.

func (UpdateSecurityControlInput) String added in v1.48.4 

func (s UpdateSecurityControlInput) String() string

String returns the string representation.

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

func (*UpdateSecurityControlInput) Validate added in v1.48.4 

func (s *UpdateSecurityControlInput) Validate() error

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

type UpdateSecurityControlOutput added in v1.48.4 

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

func (UpdateSecurityControlOutput) GoString added in v1.48.4 

func (s UpdateSecurityControlOutput) GoString() string

GoString returns the string representation.

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

func (UpdateSecurityControlOutput) String added in v1.48.4 

func (s UpdateSecurityControlOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.14 

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 added in v1.33.14 

func (s UpdateSecurityHubConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.14 

func (s *UpdateSecurityHubConfigurationInput) SetAutoEnableControls(v bool) *UpdateSecurityHubConfigurationInput

SetAutoEnableControls sets the AutoEnableControls field's value.

func (*UpdateSecurityHubConfigurationInput) SetControlFindingGenerator added in v1.44.209 

func (s *UpdateSecurityHubConfigurationInput) SetControlFindingGenerator(v string) *UpdateSecurityHubConfigurationInput

SetControlFindingGenerator sets the ControlFindingGenerator field's value.

func (UpdateSecurityHubConfigurationInput) String added in v1.33.14 

func (s UpdateSecurityHubConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.14 

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

func (UpdateSecurityHubConfigurationOutput) GoString added in v1.33.14 

func (s UpdateSecurityHubConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.14 

func (s UpdateSecurityHubConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.3 

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 added in v1.28.3 

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 added in v1.28.3 

func (s *UpdateStandardsControlInput) SetControlStatus(v string) *UpdateStandardsControlInput

SetControlStatus sets the ControlStatus field's value.

func (*UpdateStandardsControlInput) SetDisabledReason added in v1.28.3 

func (s *UpdateStandardsControlInput) SetDisabledReason(v string) *UpdateStandardsControlInput

SetDisabledReason sets the DisabledReason field's value.

func (*UpdateStandardsControlInput) SetStandardsControlArn added in v1.28.3 

func (s *UpdateStandardsControlInput) SetStandardsControlArn(v string) *UpdateStandardsControlInput

SetStandardsControlArn sets the StandardsControlArn field's value.

func (UpdateStandardsControlInput) String added in v1.28.3 

func (s UpdateStandardsControlInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.28.3 

func (s *UpdateStandardsControlInput) Validate() error

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

type UpdateStandardsControlOutput added in v1.28.3 

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

func (UpdateStandardsControlOutput) GoString added in v1.28.3 

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 added in v1.28.3 

func (s UpdateStandardsControlOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *VolumeMount) SetMountPath(v string) *VolumeMount

SetMountPath sets the MountPath field's value.

func (*VolumeMount) SetName added in v1.44.36 

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

SetName sets the Name field's value.

func (VolumeMount) String added in v1.44.36 

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.44.36 

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.44.36 

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.44.36 

func (s *VpcInfoCidrBlockSetDetails) SetCidrBlock(v string) *VpcInfoCidrBlockSetDetails

SetCidrBlock sets the CidrBlock field's value.

func (VpcInfoCidrBlockSetDetails) String added in v1.44.36 

func (s VpcInfoCidrBlockSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

func (s VpcInfoIpv6CidrBlockSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

func (s *VpcInfoIpv6CidrBlockSetDetails) SetIpv6CidrBlock(v string) *VpcInfoIpv6CidrBlockSetDetails

SetIpv6CidrBlock sets the Ipv6CidrBlock field's value.

func (VpcInfoIpv6CidrBlockSetDetails) String added in v1.44.36 

func (s VpcInfoIpv6CidrBlockSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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.44.36 

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.44.36 

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.44.36 

func (s *VpcInfoPeeringOptionsDetails) SetAllowDnsResolutionFromRemoteVpc(v bool) *VpcInfoPeeringOptionsDetails

SetAllowDnsResolutionFromRemoteVpc sets the AllowDnsResolutionFromRemoteVpc field's value.

func (*VpcInfoPeeringOptionsDetails) SetAllowEgressFromLocalClassicLinkToRemoteVpc added in v1.44.36 

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.44.36 

func (s VpcInfoPeeringOptionsDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the 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 added in v1.33.0 

type Vulnerability struct {

	// The vulnerabilities found in your Lambda function code. This field pertains
	// to findings that Security Hub receives from Amazon Inspector.
	CodeVulnerabilities []*VulnerabilityCodeVulnerabilities `type:"list"`

	// CVSS scores from the advisory related to the vulnerability.
	Cvss []*Cvss `type:"list"`

	// The Exploit Prediction Scoring System (EPSS) score for a finding.
	EpssScore *float64 `type:"double"`

	// Whether an exploit is available for a finding.
	ExploitAvailable *string `type:"string" enum:"VulnerabilityExploitAvailable"`

	// 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"`

	// The date and time of the last exploit associated with a finding discovered
	// in your environment.
	LastKnownExploitAt *string `type:"string"`

	// 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 added in v1.33.0 

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) SetCodeVulnerabilities added in v1.44.327 

func (s *Vulnerability) SetCodeVulnerabilities(v []*VulnerabilityCodeVulnerabilities) *Vulnerability

SetCodeVulnerabilities sets the CodeVulnerabilities field's value.

func (*Vulnerability) SetCvss added in v1.33.0 

func (s *Vulnerability) SetCvss(v []*Cvss) *Vulnerability

SetCvss sets the Cvss field's value.

func (*Vulnerability) SetEpssScore added in v1.44.327 

func (s *Vulnerability) SetEpssScore(v float64) *Vulnerability

SetEpssScore sets the EpssScore field's value.

func (*Vulnerability) SetExploitAvailable added in v1.44.327 

func (s *Vulnerability) SetExploitAvailable(v string) *Vulnerability

SetExploitAvailable sets the ExploitAvailable field's value.

func (*Vulnerability) SetFixAvailable added in v1.44.82 

func (s *Vulnerability) SetFixAvailable(v string) *Vulnerability

SetFixAvailable sets the FixAvailable field's value.

func (*Vulnerability) SetId added in v1.33.0 

func (s *Vulnerability) SetId(v string) *Vulnerability

SetId sets the Id field's value.

func (*Vulnerability) SetLastKnownExploitAt added in v1.51.6 

func (s *Vulnerability) SetLastKnownExploitAt(v string) *Vulnerability

SetLastKnownExploitAt sets the LastKnownExploitAt field's value.

func (*Vulnerability) SetReferenceUrls added in v1.33.0 

func (s *Vulnerability) SetReferenceUrls(v []*string) *Vulnerability

SetReferenceUrls sets the ReferenceUrls field's value.

func (*Vulnerability) SetRelatedVulnerabilities added in v1.33.0 

func (s *Vulnerability) SetRelatedVulnerabilities(v []*string) *Vulnerability

SetRelatedVulnerabilities sets the RelatedVulnerabilities field's value.

func (*Vulnerability) SetVendor added in v1.33.0 

func (s *Vulnerability) SetVendor(v *VulnerabilityVendor) *Vulnerability

SetVendor sets the Vendor field's value.

func (*Vulnerability) SetVulnerablePackages added in v1.33.0 

func (s *Vulnerability) SetVulnerablePackages(v []*SoftwarePackage) *Vulnerability

SetVulnerablePackages sets the VulnerablePackages field's value.

func (Vulnerability) String added in v1.33.0 

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 added in v1.33.0 

func (s *Vulnerability) Validate() error

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

type VulnerabilityCodeVulnerabilities added in v1.44.327 

type VulnerabilityCodeVulnerabilities struct {

	// The Common Weakness Enumeration (CWE) item associated with the detected code
	// vulnerability.
	Cwes []*string `type:"list"`

	// Provides details about where a code vulnerability is located in your Lambda
	// function.
	FilePath *CodeVulnerabilitiesFilePath `type:"structure"`

	// The Amazon Resource Name (ARN) of the Lambda layer in which the code vulnerability
	// is located.
	SourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the vulnerabilities found in your Lambda function code. This field pertains to findings that Security Hub receives from Amazon Inspector.

func (VulnerabilityCodeVulnerabilities) GoString added in v1.44.327 

func (s VulnerabilityCodeVulnerabilities) GoString() string

GoString returns the string representation.

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

func (*VulnerabilityCodeVulnerabilities) SetCwes added in v1.44.327 

func (s *VulnerabilityCodeVulnerabilities) SetCwes(v []*string) *VulnerabilityCodeVulnerabilities

SetCwes sets the Cwes field's value.

func (*VulnerabilityCodeVulnerabilities) SetFilePath added in v1.44.327 

func (s *VulnerabilityCodeVulnerabilities) SetFilePath(v *CodeVulnerabilitiesFilePath) *VulnerabilityCodeVulnerabilities

SetFilePath sets the FilePath field's value.

func (*VulnerabilityCodeVulnerabilities) SetSourceArn added in v1.44.327 

func (s *VulnerabilityCodeVulnerabilities) SetSourceArn(v string) *VulnerabilityCodeVulnerabilities

SetSourceArn sets the SourceArn field's value.

func (VulnerabilityCodeVulnerabilities) String added in v1.44.327 

func (s VulnerabilityCodeVulnerabilities) String() string

String returns the string representation.

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

type VulnerabilityVendor added in v1.33.0 

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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	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.
	//
	// This field accepts only the specified formats. Timestamps can end with Z
	// or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds
	// is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here
	// are valid timestamp formats with examples:
	//
	//    * YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
	//
	//    * YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
	//
	//    * YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
	//
	//    * YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
	VendorUpdatedAt *string `type:"string"`
	// contains filtered or unexported fields
}

A vendor that generates a vulnerability report.

func (VulnerabilityVendor) GoString added in v1.33.0 

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 added in v1.33.0 

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

SetName sets the Name field's value.

func (*VulnerabilityVendor) SetUrl added in v1.33.0 

func (s *VulnerabilityVendor) SetUrl(v string) *VulnerabilityVendor

SetUrl sets the Url field's value.

func (*VulnerabilityVendor) SetVendorCreatedAt added in v1.33.0 

func (s *VulnerabilityVendor) SetVendorCreatedAt(v string) *VulnerabilityVendor

SetVendorCreatedAt sets the VendorCreatedAt field's value.

func (*VulnerabilityVendor) SetVendorSeverity added in v1.33.0 

func (s *VulnerabilityVendor) SetVendorSeverity(v string) *VulnerabilityVendor

SetVendorSeverity sets the VendorSeverity field's value.

func (*VulnerabilityVendor) SetVendorUpdatedAt added in v1.33.0 

func (s *VulnerabilityVendor) SetVendorUpdatedAt(v string) *VulnerabilityVendor

SetVendorUpdatedAt sets the VendorUpdatedAt field's value.

func (VulnerabilityVendor) String added in v1.33.0 

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 added in v1.33.0 

func (s *VulnerabilityVendor) Validate() error

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

type WafAction added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *WafAction) SetType(v string) *WafAction

SetType sets the Type field's value.

func (WafAction) String added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *WafExcludedRule) SetRuleId(v string) *WafExcludedRule

SetRuleId sets the RuleId field's value.

func (WafExcludedRule) String added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

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 added in v1.28.11 

func (s *WafOverrideAction) SetType(v string) *WafOverrideAction

SetType sets the Type field's value.

func (WafOverrideAction) String added in v1.28.11 

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 added in v1.29.23 

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 details about the status of the investigation into a finding.

func (Workflow) GoString added in v1.29.23 

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 added in v1.29.23 

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

SetStatus sets the Status field's value.

func (Workflow) String added in v1.29.23 

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 added in v1.30.8 

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 added in v1.30.8 

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 added in v1.30.8 

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

SetStatus sets the Status field's value.

func (WorkflowUpdate) String added in v1.30.8 

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".

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.