Class Permission
- java.lang.Object
-
- software.amazon.awssdk.services.acmpca.model.Permission
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Permission.Builder,Permission>
@Generated("software.amazon.awssdk:codegen") public final class Permission extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Permission.Builder,Permission>
Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (
IssueCertificate,GetCertificate, andListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePermission.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ActionType>actions()The private CA actions that can be performed by the designated Amazon Web Services service.List<String>actionsAsStrings()The private CA actions that can be performed by the designated Amazon Web Services service.static Permission.Builderbuilder()StringcertificateAuthorityArn()The Amazon Resource Number (ARN) of the private CA from which the permission was issued.InstantcreatedAt()The time at which the permission was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActions()For responses, this returns true if the service returned a value for the Actions property.inthashCode()Stringpolicy()The name of the policy that is associated with the permission.Stringprincipal()The Amazon Web Services service or entity that holds the permission.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Permission.Builder>serializableBuilderClass()StringsourceAccount()The ID of the account that assigned the permission.Permission.BuildertoBuilder()StringtoString()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
-
certificateAuthorityArn
public final String certificateAuthorityArn()
The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
- Returns:
- The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
-
createdAt
public final Instant createdAt()
The time at which the permission was created.
- Returns:
- The time at which the permission was created.
-
principal
public final String principal()
The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is
acm.amazonaws.com.- Returns:
- The Amazon Web Services service or entity that holds the permission. At this time, the only valid
principal is
acm.amazonaws.com.
-
sourceAccount
public final String sourceAccount()
The ID of the account that assigned the permission.
- Returns:
- The ID of the account that assigned the permission.
-
actions
public final List<ActionType> actions()
The private CA actions that can be performed by the designated Amazon Web Services service.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasActions()method.- Returns:
- The private CA actions that can be performed by the designated Amazon Web Services service.
-
hasActions
public final boolean hasActions()
For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
actionsAsStrings
public final List<String> actionsAsStrings()
The private CA actions that can be performed by the designated Amazon Web Services service.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasActions()method.- Returns:
- The private CA actions that can be performed by the designated Amazon Web Services service.
-
policy
public final String policy()
The name of the policy that is associated with the permission.
- Returns:
- The name of the policy that is associated with the permission.
-
toBuilder
public Permission.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Permission.Builder,Permission>
-
builder
public static Permission.Builder builder()
-
serializableBuilderClass
public static Class<? extends Permission.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-