Class: AWS.SSMQuickSetup
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.SSMQuickSetup
- Identifier:
- ssmquicksetup
- API Version:
- 2018-05-10
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services, including Systems Manager, by automating common or recommended tasks.
Sending a Request Using SSMQuickSetup
var ssmquicksetup = new AWS.SSMQuickSetup();
ssmquicksetup.createConfigurationManager(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the SSMQuickSetup object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ssmquicksetup = new AWS.SSMQuickSetup({apiVersion: '2018-05-10'});
You can also set the API version globally in AWS.config.apiVersions
using
the ssmquicksetup service identifier:
AWS.config.apiVersions = {
ssmquicksetup: '2018-05-10',
// other service API versions
};
var ssmquicksetup = new AWS.SSMQuickSetup();
Version:
-
2018-05-10
Constructor Summary collapse
-
new AWS.SSMQuickSetup(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createConfigurationManager(params = {}, callback) ⇒ AWS.Request
Creates a Quick Setup configuration manager resource.
-
deleteConfigurationManager(params = {}, callback) ⇒ AWS.Request
Deletes a configuration manager.
.
-
getConfigurationManager(params = {}, callback) ⇒ AWS.Request
Returns a configuration manager.
.
-
getServiceSettings(params = {}, callback) ⇒ AWS.Request
Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
.
-
listConfigurationManagers(params = {}, callback) ⇒ AWS.Request
Returns Quick Setup configuration managers.
.
-
listQuickSetupTypes(params = {}, callback) ⇒ AWS.Request
Returns the available Quick Setup types.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns tags assigned to the resource.
.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Assigns key-value pairs of metadata to Amazon Web Services resources.
.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from the specified resource.
.
-
updateConfigurationDefinition(params = {}, callback) ⇒ AWS.Request
Updates a Quick Setup configuration definition.
.
-
updateConfigurationManager(params = {}, callback) ⇒ AWS.Request
Updates a Quick Setup configuration manager.
.
-
updateServiceSettings(params = {}, callback) ⇒ AWS.Request
Updates settings configured for Quick Setup.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.SSMQuickSetup(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a SSMQuickSetup object
var ssmquicksetup = new AWS.SSMQuickSetup({apiVersion: '2018-05-10'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.SSMQuickSetup.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.SSMQuickSetup.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.SSMQuickSetup.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
createConfigurationManager(params = {}, callback) ⇒ AWS.Request
Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.
Service Reference:
Examples:
Calling the createConfigurationManager operation
var params = {
ConfigurationDefinitions: [ /* required */
{
Parameters: { /* required */
'<ConfigurationParametersMapKeyString>': 'STRING_VALUE',
/* '<ConfigurationParametersMapKeyString>': ... */
},
Type: 'STRING_VALUE', /* required */
LocalDeploymentAdministrationRoleArn: 'STRING_VALUE',
LocalDeploymentExecutionRoleName: 'STRING_VALUE',
TypeVersion: 'STRING_VALUE'
},
/* more items */
],
Description: 'STRING_VALUE',
Name: 'STRING_VALUE',
Tags: {
'<TagsMapKeyString>': 'STRING_VALUE',
/* '<TagsMapKeyString>': ... */
}
};
ssmquicksetup.createConfigurationManager(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ConfigurationDefinitions
— (Array<map>
)The definition of the Quick Setup configuration that the configuration manager deploys.
LocalDeploymentAdministrationRoleArn
— (String
)The ARN of the IAM role used to administrate local configuration deployments.
LocalDeploymentExecutionRoleName
— (String
)The name of the IAM role used to deploy local configurations.
Parameters
— required — (map<String>
)The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.
- OpsCenter (Type: Amazon Web ServicesQuickSetupType-SSMOpsCenter)
-
-
DelegatedAccountId
-
Description: (Required) The ID of the delegated administrator account.
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Resource Scheduler (Type: Amazon Web ServicesQuickSetupType-Scheduler)
-
-
TargetTagKey
-
Description: (Required) The tag key assigned to the instances you want to target.
-
-
TargetTagValue
-
Description: (Required) The value of the tag key assigned to the instances you want to target.
-
-
ICalendarString
-
Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Default Host Management Configuration (Type: Amazon Web ServicesQuickSetupType-DHMC)
-
-
UpdateSSMAgent
-
Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is "
true
".
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Resource Explorer (Type: Amazon Web ServicesQuickSetupType-ResourceExplorer)
-
-
SelectedAggregatorRegion
-
Description: (Required) The Amazon Web Services Region where you want to create the aggregator index.
-
-
ReplaceExistingAggregator
-
Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the
SelectedAggregatorRegion
.
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Change Manager (Type: Amazon Web ServicesQuickSetupType-SSMChangeMgr)
-
-
DelegatedAccountId
-
Description: (Required) The ID of the delegated administrator account.
-
-
JobFunction
-
Description: (Required) The name for the Change Manager job function.
-
-
PermissionType
-
Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are
CustomPermissions
andAdminPermissions
. The default value for the parameter isCustomerPermissions
.
-
-
CustomPermissions
-
Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify
CustomPermissions
for thePermissionType
parameter.
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- DevOps Guru (Type: Amazon Web ServicesQuickSetupType-DevOpsGuru)
-
-
AnalyseAllResources
-
Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all CloudFormation stacks in the account. The default value is "
false
".
-
-
EnableSnsNotifications
-
Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is "
true
".
-
-
EnableSsmOpsItems
-
Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is "
true
".
-
-
EnableDriftRemediation
-
Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is "
false
".
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(14 days)
,rate(1 days)
, andnone
. The default value is "none
".
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Conformance Packs (Type: Amazon Web ServicesQuickSetupType-CFGCPacks)
-
-
DelegatedAccountId
-
Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(14 days)
,rate(2 days)
, andnone
. The default value is "none
".
-
-
CPackNames
-
Description: (Required) A comma separated list of Config conformance packs.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Config Recording (Type: Amazon Web ServicesQuickSetupType-CFGRecording)
-
-
RecordAllResources
-
Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is "
true
".
-
-
ResourceTypesToRecord
-
Description: (Optional) A comma separated list of resource types you want to record.
-
-
RecordGlobalResourceTypes
-
Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is "
false
".
-
-
GlobalResourceTypesRegion
-
Description: (Optional) Determines the Amazon Web Services Region where global resources are recorded.
-
-
UseCustomBucket
-
Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is "
false
".
-
-
DeliveryBucketName
-
Description: (Optional) The name of the Amazon S3 bucket you want Config to deliver configuration snapshots and configuration history files to.
-
-
DeliveryBucketPrefix
-
Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.
-
-
NotificationOptions
-
Description: (Optional) Determines the notification configuration for the recorder. The valid values are
NoStreaming
,UseExistingTopic
, andCreateTopic
. The default value isNoStreaming
.
-
-
CustomDeliveryTopicAccountId
-
Description: (Optional) The ID of the Amazon Web Services account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the
UseExistingTopic
notification option.
-
-
CustomDeliveryTopicName
-
Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the
UseExistingTopic
notification option.
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(7 days)
,rate(1 days)
, andnone
. The default value is "none
".
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Host Management (Type: Amazon Web ServicesQuickSetupType-SSMHostMgmt)
-
-
UpdateSSMAgent
-
Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is "
true
".
-
-
UpdateEc2LaunchAgent
-
Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is "
false
".
-
-
CollectInventory
-
Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is "
true
".
-
-
ScanInstances
-
Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is "
true
".
-
-
InstallCloudWatchAgent
-
Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is "
false
".
-
-
UpdateCloudWatchAgent
-
Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is "
false
".
-
-
IsPolicyAttachAllowed
-
Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is "
false
".
-
-
TargetType
-
Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are
*
,InstanceIds
,ResourceGroups
, andTags
. Use*
to target all instances in the account.
-
-
TargetInstances
-
Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify
InstanceIds
for theTargetType
parameter.
-
-
TargetTagKey
-
Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
TargetTagValue
-
Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
ResourceGroupName
-
Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify
ResourceGroups
for theTargetType
parameter.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Distributor (Type: Amazon Web ServicesQuickSetupType-Distributor)
-
-
PackagesToInstall
-
Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are
AWSEFSTools
,AWSCWAgent
, andAWSEC2LaunchAgent
.
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(14 days)
,rate(2 days)
, andnone
. The default value is "rate(30 days)
".
-
-
IsPolicyAttachAllowed
-
Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is "
false
".
-
-
TargetType
-
Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are
*
,InstanceIds
,ResourceGroups
, andTags
. Use*
to target all instances in the account.
-
-
TargetInstances
-
Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify
InstanceIds
for theTargetType
parameter.
-
-
TargetTagKey
-
Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
TargetTagValue
-
Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
ResourceGroupName
-
Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify
ResourceGroups
for theTargetType
parameter.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Patch Policy (Type: Amazon Web ServicesQuickSetupType-PatchPolicy)
-
-
PatchPolicyName
-
Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.
-
-
SelectedPatchBaselines
-
Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.
-
-
PatchBaselineUseDefault
-
Description: (Optional) A boolean value that determines whether the selected patch baselines are all Amazon Web Services provided.
-
-
ConfigurationOptionsPatchOperation
-
Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are
Scan
andScanAndInstall
. The default value for the parameter isScan
.
-
-
ConfigurationOptionsScanValue
-
Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.
-
-
ConfigurationOptionsInstallValue
-
Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.
-
-
ConfigurationOptionsScanNextInterval
-
Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is "
false
".
-
-
ConfigurationOptionsInstallNextInterval
-
Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is "
false
".
-
-
RebootOption
-
Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is "
false
".
-
-
IsPolicyAttachAllowed
-
Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is "
false
".
-
-
OutputLogEnableS3
-
Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.
-
-
OutputS3Location
-
Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.
-
OutputS3BucketRegion
-
Description: (Optional) The Amazon Web Services Region where the Amazon S3 bucket you want Config to deliver command output to is located.
-
-
OutputS3BucketName
-
Description: (Optional) The name of the Amazon S3 bucket you want Config to deliver command output to.
-
-
OutputS3KeyPrefix
-
Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.
-
-
-
-
TargetType
-
Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are
*
,InstanceIds
,ResourceGroups
, andTags
. Use*
to target all instances in the account.
-
-
TargetInstances
-
Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify
InstanceIds
for theTargetType
parameter.
-
-
TargetTagKey
-
Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
TargetTagValue
-
Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
ResourceGroupName
-
Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify
ResourceGroups
for theTargetType
parameter.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
Type
— required — (String
)The type of the Quick Setup configuration.
TypeVersion
— (String
)The version of the Quick Setup type to use.
Description
— (String
)A description of the configuration manager.
Name
— (String
)A name for the configuration manager.
Tags
— (map<String>
)Key-value pairs of metadata to assign to the configuration manager.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ManagerArn
— (String
)The ARN for the newly created configuration manager.
-
(AWS.Response)
—
Returns:
deleteConfigurationManager(params = {}, callback) ⇒ AWS.Request
Deletes a configuration manager.
Service Reference:
Examples:
Calling the deleteConfigurationManager operation
var params = {
ManagerArn: 'STRING_VALUE' /* required */
};
ssmquicksetup.deleteConfigurationManager(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ManagerArn
— (String
)The ID of the configuration manager.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
getConfigurationManager(params = {}, callback) ⇒ AWS.Request
Returns a configuration manager.
Service Reference:
Examples:
Calling the getConfigurationManager operation
var params = {
ManagerArn: 'STRING_VALUE' /* required */
};
ssmquicksetup.getConfigurationManager(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ManagerArn
— (String
)The ARN of the configuration manager.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ConfigurationDefinitions
— (Array<map>
)The configuration definitions association with the configuration manager.
Id
— (String
)The ID of the configuration definition.
LocalDeploymentAdministrationRoleArn
— (String
)The ARN of the IAM role used to administrate local configuration deployments.
LocalDeploymentExecutionRoleName
— (String
)The name of the IAM role used to deploy local configurations.
Parameters
— required — (map<String>
)A list of key-value pairs containing the required parameters for the configuration type.
Type
— required — (String
)The type of the Quick Setup configuration.
TypeVersion
— (String
)The version of the Quick Setup type used.
CreatedAt
— (Date
)The datetime stamp when the configuration manager was created.
Description
— (String
)The description of the configuration manager.
LastModifiedAt
— (Date
)The datetime stamp when the configuration manager was last updated.
ManagerArn
— (String
)The ARN of the configuration manager.
Name
— (String
)The name of the configuration manager.
StatusSummaries
— (Array<map>
)A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
LastUpdatedAt
— required — (Date
)The datetime stamp when the status was last updated.
Status
— (String
)The current status.
Possible values include:"INITIALIZING"
"DEPLOYING"
"SUCCEEDED"
"DELETING"
"STOPPING"
"FAILED"
"STOPPED"
"DELETE_FAILED"
"STOP_FAILED"
"NONE"
StatusDetails
— (map<String>
)Details about the status.
StatusMessage
— (String
)When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
StatusType
— required — (String
)The type of a status summary.
Possible values include:"Deployment"
"AsyncExecutions"
Tags
— (map<String>
)Key-value pairs of metadata to assign to the configuration manager.
-
(AWS.Response)
—
Returns:
getServiceSettings(params = {}, callback) ⇒ AWS.Request
Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
Service Reference:
Examples:
Calling the getServiceSettings operation
ssmquicksetup.getServiceSettings(function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ServiceSettings
— (map
)Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
ExplorerEnablingRoleArn
— (String
)The IAM role used to enable Explorer.
-
(AWS.Response)
—
Returns:
listConfigurationManagers(params = {}, callback) ⇒ AWS.Request
Returns Quick Setup configuration managers.
Service Reference:
Examples:
Calling the listConfigurationManagers operation
var params = {
Filters: [
{
Key: 'STRING_VALUE', /* required */
Values: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
MaxItems: 'NUMBER_VALUE',
StartingToken: 'STRING_VALUE'
};
ssmquicksetup.listConfigurationManagers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Filters
— (Array<map>
)Filters the results returned by the request.
Key
— required — (String
)The key for the filter.
Values
— required — (Array<String>
)The values for the filter keys.
MaxItems
— (Integer
)Specifies the maximum number of configuration managers that are returned by the request.
StartingToken
— (String
)The token to use when requesting a specific set of items from a list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ConfigurationManagersList
— (Array<map>
)The configuration managers returned by the request.
ConfigurationDefinitionSummaries
— (Array<map>
)A summary of the Quick Setup configuration definition.
FirstClassParameters
— (map<String>
)The common parameters and values for the configuration definition.
Id
— (String
)The ID of the configuration definition.
Type
— (String
)The type of the Quick Setup configuration used by the configuration definition.
TypeVersion
— (String
)The version of the Quick Setup type used by the configuration definition.
Description
— (String
)The description of the configuration.
ManagerArn
— required — (String
)The ARN of the Quick Setup configuration.
Name
— (String
)The name of the configuration
StatusSummaries
— (Array<map>
)Summaries of the state of the configuration manager. These summaries include an aggregate of the statuses from the configuration definition associated with the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
LastUpdatedAt
— required — (Date
)The datetime stamp when the status was last updated.
Status
— (String
)The current status.
Possible values include:"INITIALIZING"
"DEPLOYING"
"SUCCEEDED"
"DELETING"
"STOPPING"
"FAILED"
"STOPPED"
"DELETE_FAILED"
"STOP_FAILED"
"NONE"
StatusDetails
— (map<String>
)Details about the status.
StatusMessage
— (String
)When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
StatusType
— required — (String
)The type of a status summary.
Possible values include:"Deployment"
"AsyncExecutions"
NextToken
— (String
)The token to use when requesting the next set of configuration managers. If there are no additional operations to return, the string is empty.
-
(AWS.Response)
—
Returns:
listQuickSetupTypes(params = {}, callback) ⇒ AWS.Request
Returns the available Quick Setup types.
Service Reference:
Examples:
Calling the listQuickSetupTypes operation
ssmquicksetup.listQuickSetupTypes(function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:QuickSetupTypeList
— (Array<map>
)An array of Quick Setup types.
LatestVersion
— (String
)The latest version number of the configuration.
Type
— (String
)The type of the Quick Setup configuration.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns tags assigned to the resource.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = {
ResourceArn: 'STRING_VALUE' /* required */
};
ssmquicksetup.listTagsForResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The ARN of the resource the tag is assigned to.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Tags
— (Array<map>
)Key-value pairs of metadata assigned to the resource.
Key
— (String
)The key for the tag.
Value
— (String
)The value for the tag.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Assigns key-value pairs of metadata to Amazon Web Services resources.
Service Reference:
Examples:
Calling the tagResource operation
var params = {
ResourceArn: 'STRING_VALUE', /* required */
Tags: { /* required */
'<TagsMapKeyString>': 'STRING_VALUE',
/* '<TagsMapKeyString>': ... */
}
};
ssmquicksetup.tagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The ARN of the resource to tag.
Tags
— (map<String>
)Key-value pairs of metadata to assign to the resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from the specified resource.
Service Reference:
Examples:
Calling the untagResource operation
var params = {
ResourceArn: 'STRING_VALUE', /* required */
TagKeys: [ /* required */
'STRING_VALUE',
/* more items */
]
};
ssmquicksetup.untagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The ARN of the resource to remove tags from.
TagKeys
— (Array<String>
)The keys of the tags to remove from the resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateConfigurationDefinition(params = {}, callback) ⇒ AWS.Request
Updates a Quick Setup configuration definition.
Service Reference:
Examples:
Calling the updateConfigurationDefinition operation
var params = {
Id: 'STRING_VALUE', /* required */
ManagerArn: 'STRING_VALUE', /* required */
LocalDeploymentAdministrationRoleArn: 'STRING_VALUE',
LocalDeploymentExecutionRoleName: 'STRING_VALUE',
Parameters: {
'<ConfigurationParametersMapKeyString>': 'STRING_VALUE',
/* '<ConfigurationParametersMapKeyString>': ... */
},
TypeVersion: 'STRING_VALUE'
};
ssmquicksetup.updateConfigurationDefinition(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Id
— (String
)The ID of the configuration definition you want to update.
LocalDeploymentAdministrationRoleArn
— (String
)The ARN of the IAM role used to administrate local configuration deployments.
LocalDeploymentExecutionRoleName
— (String
)The name of the IAM role used to deploy local configurations.
ManagerArn
— (String
)The ARN of the configuration manager associated with the definition to update.
Parameters
— (map<String>
)The parameters for the configuration definition type.
TypeVersion
— (String
)The version of the Quick Setup type to use.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateConfigurationManager(params = {}, callback) ⇒ AWS.Request
Updates a Quick Setup configuration manager.
Service Reference:
Examples:
Calling the updateConfigurationManager operation
var params = {
ManagerArn: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE',
Name: 'STRING_VALUE'
};
ssmquicksetup.updateConfigurationManager(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Description
— (String
)A description of the configuration manager.
ManagerArn
— (String
)The ARN of the configuration manager.
Name
— (String
)A name for the configuration manager.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateServiceSettings(params = {}, callback) ⇒ AWS.Request
Updates settings configured for Quick Setup.
Service Reference:
Examples:
Calling the updateServiceSettings operation
var params = {
ExplorerEnablingRoleArn: 'STRING_VALUE'
};
ssmquicksetup.updateServiceSettings(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ExplorerEnablingRoleArn
— (String
)The IAM role used to enable Explorer.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns: