Class CfnConfigurationManager.ConfigurationDefinitionProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConfigurationManager.ConfigurationDefinitionProperty>
- Enclosing interface:
CfnConfigurationManager.ConfigurationDefinitionProperty
CfnConfigurationManager.ConfigurationDefinitionProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getId()localDeploymentAdministrationRoleArn(String localDeploymentAdministrationRoleArn) localDeploymentExecutionRoleName(String localDeploymentExecutionRoleName) parameters(Map<String, String> parameters) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getParameters()parameters(IResolvable parameters) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getParameters()Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getType()typeVersion(String typeVersion) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getTypeVersion()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
parameters
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder parameters(Map<String, String> parameters) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getParameters()- Parameters:
parameters- The parameters for the configuration definition type. This parameter is required. Parameters for configuration definitions vary based the configuration type. The following lists outline the parameters for each configuration type.- AWS Config Recording (Type: AWS QuickSetupType-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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Regions you want to deploy the configuration to.
- Change Manager (Type: AWS QuickSetupType-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 AWS Regions you want to deploy the configuration to.
- Conformance Packs (Type: AWS QuickSetupType-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 AWS Config conformance packs.
TargetAccounts- Description: (Optional) The ID of the AWS 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 AWS Regions you want to deploy the configuration to.
- Default Host Management Configuration (Type: AWS QuickSetupType-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 AWS Regions you want to deploy the configuration to.
- DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - -
AnalyseAllResources - Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS 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 AWS 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 AWS Regions you want to deploy the configuration to.
- Distributor (Type: AWS QuickSetupType-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 AWS 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 AWS Regions you want to deploy the configuration to.
- Host Management (Type: AWS QuickSetupType-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 instance metadata is collected on the target instances every 30 minutes. 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 AWS 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 AWS Regions you want to deploy the configuration to.
- OpsCenter (Type: AWS QuickSetupType-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 AWS Regions you want to deploy the configuration to.
- Patch Policy (Type: AWS QuickSetupType-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 value that determines whether the selected patch baselines are all AWS provided. Supported values are
defaultandcustom. PatchBaselineRegion- Description: (Required) The AWS Region where the patch baseline exist.
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) Information about the Amazon S3 bucket where you want to store the output details of the request.
OutputBucketRegion- Description: (Optional) The AWS Region where the Amazon S3 bucket you want to deliver command output to is located.
OutputS3BucketName- Description: (Optional) The name of the Amazon S3 bucket you want 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 AWS 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 AWS Regions you want to deploy the configuration to.
- Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - -
SelectedAggregatorRegion - Description: (Required) The AWS 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 AWS Regions you want to deploy the configuration to.
- Resource Scheduler (Type: AWS QuickSetupType-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 AWS 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 AWS Regions you want to deploy the configuration to.
- AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - -
- Returns:
this
-
parameters
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder parameters(IResolvable parameters) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getParameters()- Parameters:
parameters- The parameters for the configuration definition type. This parameter is required. Parameters for configuration definitions vary based the configuration type. The following lists outline the parameters for each configuration type.- AWS Config Recording (Type: AWS QuickSetupType-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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Regions you want to deploy the configuration to.
- Change Manager (Type: AWS QuickSetupType-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 AWS Regions you want to deploy the configuration to.
- Conformance Packs (Type: AWS QuickSetupType-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 AWS Config conformance packs.
TargetAccounts- Description: (Optional) The ID of the AWS 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 AWS Regions you want to deploy the configuration to.
- Default Host Management Configuration (Type: AWS QuickSetupType-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 AWS Regions you want to deploy the configuration to.
- DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - -
AnalyseAllResources - Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS 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 AWS 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 AWS Regions you want to deploy the configuration to.
- Distributor (Type: AWS QuickSetupType-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 AWS 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 AWS Regions you want to deploy the configuration to.
- Host Management (Type: AWS QuickSetupType-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 instance metadata is collected on the target instances every 30 minutes. 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 AWS 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 AWS Regions you want to deploy the configuration to.
- OpsCenter (Type: AWS QuickSetupType-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 AWS Regions you want to deploy the configuration to.
- Patch Policy (Type: AWS QuickSetupType-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 value that determines whether the selected patch baselines are all AWS provided. Supported values are
defaultandcustom. PatchBaselineRegion- Description: (Required) The AWS Region where the patch baseline exist.
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) Information about the Amazon S3 bucket where you want to store the output details of the request.
OutputBucketRegion- Description: (Optional) The AWS Region where the Amazon S3 bucket you want to deliver command output to is located.
OutputS3BucketName- Description: (Optional) The name of the Amazon S3 bucket you want 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 AWS 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 AWS Regions you want to deploy the configuration to.
- Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - -
SelectedAggregatorRegion - Description: (Required) The AWS 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 AWS Regions you want to deploy the configuration to.
- Resource Scheduler (Type: AWS QuickSetupType-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 AWS 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 AWS Regions you want to deploy the configuration to.
- AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - -
- Returns:
this
-
type
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder type(String type) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getType()- Parameters:
type- The type of the Quick Setup configuration. This parameter is required.- Returns:
this
-
id
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder id(String id) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getId()- Parameters:
id- The ID of the configuration definition.- Returns:
this
-
localDeploymentAdministrationRoleArn
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder localDeploymentAdministrationRoleArn(String localDeploymentAdministrationRoleArn) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getLocalDeploymentAdministrationRoleArn()- Parameters:
localDeploymentAdministrationRoleArn- The ARN of the IAM role used to administrate local configuration deployments.Although this element is listed as "Required: No", a value can be omitted only for organizational deployments of types other than
AWSQuickSetupType-PatchPolicy. A value must be provided when you are running an organizational deployment for a patch policy or running any type of deployment for a single account.- Returns:
this
-
localDeploymentExecutionRoleName
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder localDeploymentExecutionRoleName(String localDeploymentExecutionRoleName) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getLocalDeploymentExecutionRoleName()- Parameters:
localDeploymentExecutionRoleName- The name of the IAM role used to deploy local configurations.Although this element is listed as "Required: No", a value can be omitted only for organizational deployments of types other than
AWSQuickSetupType-PatchPolicy. A value must be provided when you are running an organizational deployment for a patch policy or running any type of deployment for a single account.- Returns:
this
-
typeVersion
@Stability(Stable) public CfnConfigurationManager.ConfigurationDefinitionProperty.Builder typeVersion(String typeVersion) Sets the value ofCfnConfigurationManager.ConfigurationDefinitionProperty.getTypeVersion()- Parameters:
typeVersion- The version of the Quick Setup type used.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnConfigurationManager.ConfigurationDefinitionProperty>- Returns:
- a new instance of
CfnConfigurationManager.ConfigurationDefinitionProperty - Throws:
NullPointerException- if any required attribute was not provided
-