software.amazon.awscdk.services.config

Class CfnOrganizationConformancePack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.config.CfnOrganizationConformancePack

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.732Z")
 @Stability(value=Stable)
public class CfnOrganizationConformancePack
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Config::OrganizationConformancePack`.

OrganizationConformancePack deploys conformance packs across member accounts in an AWS Organizations . OrganizationConformancePack enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role in the master account of your organization. The service linked role is created only when the role does not exist in the master account.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 CfnOrganizationConformancePack cfnOrganizationConformancePack = CfnOrganizationConformancePack.Builder.create(this, "MyCfnOrganizationConformancePack")
         .organizationConformancePackName("organizationConformancePackName")
         // the properties below are optional
         .conformancePackInputParameters(List.of(ConformancePackInputParameterProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .deliveryS3Bucket("deliveryS3Bucket")
         .deliveryS3KeyPrefix("deliveryS3KeyPrefix")
         .excludedAccounts(List.of("excludedAccounts"))
         .templateBody("templateBody")
         .templateS3Uri("templateS3Uri")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnOrganizationConformancePack.Builder A fluent builder for CfnOrganizationConformancePack.
static interface	CfnOrganizationConformancePack.ConformancePackInputParameterProperty Input parameters in the form of key-value pairs for the conformance pack, both of which you define.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnOrganizationConformancePack(software.constructs.Construct scope, String id, CfnOrganizationConformancePackProps props) Create a new `AWS::Config::OrganizationConformancePack`.
protected	CfnOrganizationConformancePack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOrganizationConformancePack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getConformancePackInputParameters() A list of `ConformancePackInputParameter` objects.
String	getDeliveryS3Bucket() The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
String	getDeliveryS3KeyPrefix() Any folder structure you want to add to an Amazon S3 bucket.
List<String>	getExcludedAccounts() A comma-separated list of accounts excluded from organization conformance pack.
String	getOrganizationConformancePackName() The name you assign to an organization conformance pack.
String	getTemplateBody() A string containing full conformance pack template body.
String	getTemplateS3Uri() Location of file containing the template body.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConformancePackInputParameters(IResolvable value) A list of `ConformancePackInputParameter` objects.
void	setConformancePackInputParameters(List<Object> value) A list of `ConformancePackInputParameter` objects.
void	setDeliveryS3Bucket(String value) The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
void	setDeliveryS3KeyPrefix(String value) Any folder structure you want to add to an Amazon S3 bucket.
void	setExcludedAccounts(List<String> value) A comma-separated list of accounts excluded from organization conformance pack.
void	setOrganizationConformancePackName(String value) The name you assign to an organization conformance pack.
void	setTemplateBody(String value) A string containing full conformance pack template body.
void	setTemplateS3Uri(String value) Location of file containing the template body.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnOrganizationConformancePack

protected CfnOrganizationConformancePack(software.amazon.jsii.JsiiObjectRef objRef)

CfnOrganizationConformancePack

protected CfnOrganizationConformancePack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnOrganizationConformancePack

@Stability(value=Stable)
public CfnOrganizationConformancePack(@NotNull
                                                               software.constructs.Construct scope,
                                                               @NotNull
                                                               String id,
                                                               @NotNull
                                                               CfnOrganizationConformancePackProps props)

Create a new `AWS::Config::OrganizationConformancePack`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getOrganizationConformancePackName

@Stability(value=Stable)
 @NotNull
public String getOrganizationConformancePackName()

The name you assign to an organization conformance pack.

setOrganizationConformancePackName

@Stability(value=Stable)
public void setOrganizationConformancePackName(@NotNull
                                                                        String value)

The name you assign to an organization conformance pack.

getConformancePackInputParameters

@Stability(value=Stable)
 @Nullable
public Object getConformancePackInputParameters()

A list of `ConformancePackInputParameter` objects.

setConformancePackInputParameters

@Stability(value=Stable)
public void setConformancePackInputParameters(@Nullable
                                                                       IResolvable value)

A list of `ConformancePackInputParameter` objects.

setConformancePackInputParameters

@Stability(value=Stable)
public void setConformancePackInputParameters(@Nullable
                                                                       List<Object> value)

A list of `ConformancePackInputParameter` objects.

getDeliveryS3Bucket

@Stability(value=Stable)
 @Nullable
public String getDeliveryS3Bucket()

The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

setDeliveryS3Bucket

@Stability(value=Stable)
public void setDeliveryS3Bucket(@Nullable
                                                         String value)

The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

getDeliveryS3KeyPrefix

@Stability(value=Stable)
 @Nullable
public String getDeliveryS3KeyPrefix()

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

setDeliveryS3KeyPrefix

@Stability(value=Stable)
public void setDeliveryS3KeyPrefix(@Nullable
                                                            String value)

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

getExcludedAccounts

@Stability(value=Stable)
 @Nullable
public List<String> getExcludedAccounts()

A comma-separated list of accounts excluded from organization conformance pack.

setExcludedAccounts

@Stability(value=Stable)
public void setExcludedAccounts(@Nullable
                                                         List<String> value)

A comma-separated list of accounts excluded from organization conformance pack.

getTemplateBody

@Stability(value=Stable)
 @Nullable
public String getTemplateBody()

A string containing full conformance pack template body.

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

setTemplateBody

@Stability(value=Stable)
public void setTemplateBody(@Nullable
                                                     String value)

A string containing full conformance pack template body.

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

getTemplateS3Uri

@Stability(value=Stable)
 @Nullable
public String getTemplateS3Uri()

Location of file containing the template body.

The uri must point to the conformance pack template (max size: 300 KB).

setTemplateS3Uri

@Stability(value=Stable)
public void setTemplateS3Uri(@Nullable
                                                      String value)

Location of file containing the template body.

The uri must point to the conformance pack template (max size: 300 KB).