#[non_exhaustive]pub struct ConfigurationDefinitionInput {
pub type: String,
pub parameters: HashMap<String, String>,
pub type_version: Option<String>,
pub local_deployment_execution_role_name: Option<String>,
pub local_deployment_administration_role_arn: Option<String>,
}Expand description
Defines the preferences and options for a configuration definition.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.type: StringThe type of the Quick Setup configuration.
parameters: HashMap<String, 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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
CustomPermissionsandAdminPermissions. 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
CustomPermissionsfor thePermissionTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
UseExistingTopicnotification 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
UseExistingTopicnotification 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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
InstanceIdsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
ResourceGroupsfor theTargetTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
InstanceIdsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
ResourceGroupsfor theTargetTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
ScanandScanAndInstall. 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) Determines whether instances are rebooted after patches are installed. Valid values are
RebootIfNeededandNoReboot.
-
-
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
InstanceIdsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
ResourceGroupsfor theTargetTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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_version: Option<String>The version of the Quick Setup type to use.
local_deployment_execution_role_name: Option<String>The name of the IAM role used to deploy local configurations.
local_deployment_administration_role_arn: Option<String>The ARN of the IAM role used to administrate local configuration deployments.
Implementations§
Source§impl ConfigurationDefinitionInput
impl ConfigurationDefinitionInput
Sourcepub fn parameters(&self) -> &HashMap<String, String>
pub fn parameters(&self) -> &HashMap<String, 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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
CustomPermissionsandAdminPermissions. 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
CustomPermissionsfor thePermissionTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
UseExistingTopicnotification 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
UseExistingTopicnotification 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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
InstanceIdsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
ResourceGroupsfor theTargetTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
InstanceIdsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
ResourceGroupsfor theTargetTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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
ScanandScanAndInstall. 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) Determines whether instances are rebooted after patches are installed. Valid values are
RebootIfNeededandNoReboot.
-
-
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
InstanceIdsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
Tagsfor theTargetTypeparameter.
-
-
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
ResourceGroupsfor theTargetTypeparameter.
-
-
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
TargetAccountsorTargetOrganizationalUnits.
-
-
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.
-
-
Sourcepub fn type_version(&self) -> Option<&str>
pub fn type_version(&self) -> Option<&str>
The version of the Quick Setup type to use.
Sourcepub fn local_deployment_execution_role_name(&self) -> Option<&str>
pub fn local_deployment_execution_role_name(&self) -> Option<&str>
The name of the IAM role used to deploy local configurations.
Sourcepub fn local_deployment_administration_role_arn(&self) -> Option<&str>
pub fn local_deployment_administration_role_arn(&self) -> Option<&str>
The ARN of the IAM role used to administrate local configuration deployments.
Source§impl ConfigurationDefinitionInput
impl ConfigurationDefinitionInput
Sourcepub fn builder() -> ConfigurationDefinitionInputBuilder
pub fn builder() -> ConfigurationDefinitionInputBuilder
Creates a new builder-style object to manufacture ConfigurationDefinitionInput.
Trait Implementations§
Source§impl Clone for ConfigurationDefinitionInput
impl Clone for ConfigurationDefinitionInput
Source§fn clone(&self) -> ConfigurationDefinitionInput
fn clone(&self) -> ConfigurationDefinitionInput
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ConfigurationDefinitionInput
impl Debug for ConfigurationDefinitionInput
impl StructuralPartialEq for ConfigurationDefinitionInput
Auto Trait Implementations§
impl Freeze for ConfigurationDefinitionInput
impl RefUnwindSafe for ConfigurationDefinitionInput
impl Send for ConfigurationDefinitionInput
impl Sync for ConfigurationDefinitionInput
impl Unpin for ConfigurationDefinitionInput
impl UnsafeUnpin for ConfigurationDefinitionInput
impl UnwindSafe for ConfigurationDefinitionInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);