Package software.amazon.awssdk.services.controlcatalog.model

Class ControlParameter

java.lang.Object

software.amazon.awssdk.services.controlcatalog.model.ControlParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ControlParameter.Builder,ControlParameter>

@Generated("software.amazon.awssdk:codegen")
public final class ControlParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ControlParameter.Builder,ControlParameter>

Four types of control parameters are supported.

• AllowedRegions: List of Amazon Web Services Regions exempted from the control. Each string is expected to be an Amazon Web Services Region code. This parameter is mandatory for the OU Region deny control, CT.MULTISERVICE.PV.1.

  Example: ["us-east-1","us-west-2"]

• ExemptedActions: List of Amazon Web Services IAM actions exempted from the control. Each string is expected to be an IAM action.

  Example: ["logs:DescribeLogGroups","logs:StartQuery","logs:GetQueryResults"]

• ExemptedPrincipalArns: List of Amazon Web Services IAM principal ARNs exempted from the control. Each string is expected to be an IAM principal that follows the pattern ^arn:(aws|aws-us-gov):(iam|sts)::.+:.+$

  Example: ["arn:aws:iam::*:role/ReadOnly","arn:aws:sts::*:assumed-role/ReadOnly/*"]

• ExemptedResourceArns: List of resource ARNs exempted from the control. Each string is expected to be a resource ARN.

  Example: ["arn:aws:s3:::my-bucket-name"]

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ControlParameter.Builder

Method Summary

Modifier and Type	Method	Description
static ControlParameter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The parameter name.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ControlParameter.Builder>	serializableBuilderClass()
ControlParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The parameter name. This name is the parameter key when you call EnableControl or UpdateEnabledControl .

Returns:

The parameter name. This name is the parameter key when you call EnableControl or UpdateEnabledControl .

toBuilder

public ControlParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ControlParameter.Builder,ControlParameter>

builder

public static ControlParameter.Builder builder()

serializableBuilderClass

public static Class<? extends ControlParameter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo